tray_bubble_view.h revision c2e0dbddbe15c98d52c4786dac06cb8952a8ae6d
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef UI_VIEWS_BUBBLE_TRAY_BUBBLE_VIEW_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UI_VIEWS_BUBBLE_TRAY_BUBBLE_VIEW_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 82a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/memory/scoped_ptr.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/views/bubble/bubble_delegate.h" 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/views/views_export.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Specialized bubble view for bubbles associated with a tray icon (e.g. the 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Ash status area). Mostly this handles custom anchor location and arrow and 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// border rendering. This also has its own delegate for handling mouse events 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// and other implementation specific details. 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace ui { 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class LocatedEvent; 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace views { 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class View; 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Widget; 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace views { 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace internal { 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class TrayBubbleBorder; 302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class TrayBubbleContentMask; 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class VIEWS_EXPORT TrayBubbleView : public views::BubbleDelegateView { 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // AnchorType differentiates between bubbles that are anchored on a tray 362a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // element (ANCHOR_TYPE_TRAY) and display an arrow, or that are floating on 372a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // the screen away from the tray (ANCHOR_TYPE_BUBBLE). 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum AnchorType { 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ANCHOR_TYPE_TRAY, 402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) ANCHOR_TYPE_BUBBLE, 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // AnchorAlignment determines to which side of the anchor the bubble will 442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // align itself. 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum AnchorAlignment { 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ANCHOR_ALIGNMENT_BOTTOM, 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ANCHOR_ALIGNMENT_LEFT, 482a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) ANCHOR_ALIGNMENT_RIGHT, 492a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) ANCHOR_ALIGNMENT_TOP 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class VIEWS_EXPORT Delegate { 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef TrayBubbleView::AnchorType AnchorType; 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef TrayBubbleView::AnchorAlignment AnchorAlignment; 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Delegate() {} 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~Delegate() {} 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when the view is destroyed. Any pointers to the view should be 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // cleared when this gets called. 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void BubbleViewDestroyed() = 0; 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when the mouse enters/exits the view. 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnMouseEnteredView() = 0; 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnMouseExitedView() = 0; 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called from GetAccessibleState(); should return the appropriate 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // accessible name for the bubble. 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual string16 GetAccessibleNameForBubble() = 0; 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Passes responsibility for BubbleDelegateView::GetAnchorRect to the 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // delegate. 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual gfx::Rect GetAnchorRect(views::Widget* anchor_widget, 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AnchorType anchor_type, 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AnchorAlignment anchor_alignment) = 0; 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a bubble wants to hide/destroy itself (e.g. last visible 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // child view was closed). 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void HideBubble(const TrayBubbleView* bubble_view) = 0; 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(Delegate); 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct VIEWS_EXPORT InitParams { 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const int kArrowDefaultOffset; 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) InitParams(AnchorType anchor_type, 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AnchorAlignment anchor_alignment, 912a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) int min_width, 922a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) int max_width); 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AnchorType anchor_type; 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AnchorAlignment anchor_alignment; 952a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) int min_width; 962a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) int max_width; 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int max_height; 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool can_activate; 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool close_on_deactivate; 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SkColor arrow_color; 101c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) views::BubbleBorder::Arrow arrow; 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int arrow_offset; 1032a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) views::BubbleBorder::ArrowPaintType arrow_paint_type; 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) views::BubbleBorder::Shadow shadow; 1052a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) views::BubbleBorder::BubbleAlignment arrow_alignment; 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Constructs and returns a TrayBubbleView. init_params may be modified. 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static TrayBubbleView* Create(gfx::NativeView parent_window, 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) views::View* anchor, 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Delegate* delegate, 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) InitParams* init_params); 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~TrayBubbleView(); 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sets up animations, and show the bubble. Must occur after CreateBubble() 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // is called. 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void InitializeAndShowBubble(); 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called whenever the bubble size or location may have changed. 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void UpdateBubble(); 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sets the maximum bubble height and resizes the bubble. 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetMaxHeight(int height); 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Sets the bubble width. 1272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void SetWidth(int width); 1282a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sets whether or not to paint the bubble border arrow. 1302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void SetArrowPaintType(views::BubbleBorder::ArrowPaintType arrow_paint_type); 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the border insets. Called by TrayEventFilter. 1332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) gfx::Insets GetBorderInsets() const; 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when the delegate is destroyed. 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void reset_delegate() { delegate_ = NULL; } 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Delegate* delegate() { return delegate_; } 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_gesture_dragging(bool dragging) { is_gesture_dragging_ = dragging; } 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_gesture_dragging() const { return is_gesture_dragging_; } 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Overridden from views::WidgetDelegate. 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool CanActivate() const OVERRIDE; 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual views::NonClientFrameView* CreateNonClientFrameView( 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) views::Widget* widget) OVERRIDE; 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool WidgetHasHitTestMask() const OVERRIDE; 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void GetWidgetHitTestMask(gfx::Path* mask) const OVERRIDE; 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Overridden from views::BubbleDelegateView. 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual gfx::Rect GetAnchorRect() OVERRIDE; 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Overridden from views::View. 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual gfx::Size GetPreferredSize() OVERRIDE; 1552a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual gfx::Size GetMaximumSize() OVERRIDE; 156c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual int GetHeightForWidth(int width) OVERRIDE; 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnMouseEntered(const ui::MouseEvent& event) OVERRIDE; 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnMouseExited(const ui::MouseEvent& event) OVERRIDE; 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void GetAccessibleState(ui::AccessibleViewState* state) OVERRIDE; 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TrayBubbleView(gfx::NativeView parent_window, 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) views::View* anchor, 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Delegate* delegate, 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const InitParams& init_params); 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Overridden from views::BubbleDelegateView. 1685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void Init() OVERRIDE; 1695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Overridden from views::View. 1715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void ChildPreferredSizeChanged(View* child) OVERRIDE; 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void ViewHierarchyChanged(bool is_add, 1735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) views::View* parent, 1745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) views::View* child) OVERRIDE; 1755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 1775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) InitParams params_; 1785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Delegate* delegate_; 1792a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) int preferred_width_; 1805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) internal::TrayBubbleBorder* bubble_border_; 1812a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) scoped_ptr<internal::TrayBubbleContentMask> bubble_content_mask_; 1825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_gesture_dragging_; 1835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(TrayBubbleView); 1855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace views 1885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // UI_VIEWS_BUBBLE_TRAY_BUBBLE_VIEW_H_ 190