blob: 80436bd84c80664207cdd7ea44a68c7fbdb89b01 [file] [log] [blame]
// Copyright 2013 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <memory>
#include "base/macros.h"
#include "base/scoped_observer.h"
#include "base/strings/string16.h"
#include "base/timer/timer.h"
#include "ui/views/bubble/bubble_border.h"
#include "ui/views/controls/image_view.h"
#include "ui/views/mouse_watcher.h"
#include "ui/views/widget/widget.h"
#include "ui/views/widget/widget_observer.h"
namespace views {
class InfoBubble;
// A tooltip icon that shows a bubble on hover. Looks like (i).
class VIEWS_EXPORT TooltipIcon : public ImageView,
public MouseWatcherListener,
public WidgetObserver {
class Observer : public base::CheckedObserver {
// Called when tooltip bubble of the TooltipIcon is shown.
virtual void OnTooltipBubbleShown(TooltipIcon* icon) = 0;
// Called when the TooltipIcon is being destroyed.
virtual void OnTooltipIconDestroying(TooltipIcon* icon) = 0;
explicit TooltipIcon(const base::string16& tooltip,
int tooltip_icon_size = 16);
~TooltipIcon() override;
// ImageView:
void OnMouseEntered(const ui::MouseEvent& event) override;
void OnMouseExited(const ui::MouseEvent& event) override;
bool OnMousePressed(const ui::MouseEvent& event) override;
void OnGestureEvent(ui::GestureEvent* event) override;
void GetAccessibleNodeData(ui::AXNodeData* node_data) override;
// MouseWatcherListener:
void MouseMovedOutOfHost() override;
// WidgetObserver:
void OnWidgetDestroyed(Widget* widget) override;
void set_bubble_width(int preferred_width) {
preferred_width_ = preferred_width;
void set_anchor_point_arrow(BubbleBorder::Arrow arrow) {
anchor_point_arrow_ = arrow;
void AddObserver(Observer* observer);
void RemoveObserver(Observer* observer);
// Changes the color to reflect the hover node_data.
void SetDrawAsHovered(bool hovered);
// Creates and shows |bubble_|. If |bubble_| already exists, just cancels a
// potential close timer.
void ShowBubble();
// Hides |bubble_| if necessary.
void HideBubble();
// The text to show in a bubble when hovered.
base::string16 tooltip_;
// The size of the tooltip icon, in dip.
// Must be set in the constructor, otherwise the pre-hovered icon will show
// the default size.
int tooltip_icon_size_;
// The point at which to anchor the tooltip.
BubbleBorder::Arrow anchor_point_arrow_ = BubbleBorder::TOP_RIGHT;
// Whether the mouse is inside this tooltip.
bool mouse_inside_;
// A bubble shown on hover. Weak; owns itself. NULL while hiding.
InfoBubble* bubble_;
// The width the tooltip prefers to be. Default is 0 (no preference).
int preferred_width_;
// A timer to delay showing |bubble_|.
base::OneShotTimer show_timer_;
// A watcher that keeps |bubble_| open if the user's mouse enters it.
std::unique_ptr<MouseWatcher> mouse_watcher_;
ScopedObserver<Widget, WidgetObserver> observer_{this};
base::ObserverList<Observer, /*check_empty=*/true> observers_;
} // namespace views