• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright 2013 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 
5 #ifndef ASH_SYSTEM_TRAY_ACTIONABLE_VIEW_H_
6 #define ASH_SYSTEM_TRAY_ACTIONABLE_VIEW_H_
7 
8 #include "ash/ash_export.h"
9 #include "base/basictypes.h"
10 #include "base/compiler_specific.h"
11 #include "ui/views/view.h"
12 
13 namespace ash {
14 namespace internal {
15 
16 // A focusable view that performs an action when user clicks on it, or presses
17 // enter or space when focused. Note that the action is triggered on mouse-up,
18 // instead of on mouse-down. So if user presses the mouse on the view, then
19 // moves the mouse out of the view and then releases, then the action will not
20 // be performed.
21 // Exported for SystemTray.
22 class ASH_EXPORT ActionableView : public views::View {
23  public:
24   static const char kViewClassName[];
25 
26   ActionableView();
27 
28   virtual ~ActionableView();
29 
30   void SetAccessibleName(const base::string16& name);
accessible_name()31   const base::string16& accessible_name() const { return accessible_name_; }
32 
33  protected:
34   void OnPaintFocus(gfx::Canvas* canvas);
35 
36   // Returns the bounds to paint the focus rectangle in.
37   virtual gfx::Rect GetFocusBounds();
38 
39   // Performs an action when user clicks on the view (on mouse-press event), or
40   // presses a key when this view is in focus. Returns true if the event has
41   // been handled and an action was performed. Returns false otherwise.
42   virtual bool PerformAction(const ui::Event& event) = 0;
43 
44   // Overridden from views::View.
45   virtual const char* GetClassName() const OVERRIDE;
46   virtual bool OnKeyPressed(const ui::KeyEvent& event) OVERRIDE;
47   virtual bool OnMousePressed(const ui::MouseEvent& event) OVERRIDE;
48   virtual void OnMouseReleased(const ui::MouseEvent& event) OVERRIDE;
49   virtual void OnMouseCaptureLost() OVERRIDE;
50   virtual void GetAccessibleState(ui::AccessibleViewState* state) OVERRIDE;
51   virtual void OnPaint(gfx::Canvas* canvas) OVERRIDE;
52   virtual void OnFocus() OVERRIDE;
53   virtual void OnBlur() OVERRIDE;
54 
55   // Overridden from ui::EventHandler.
56   virtual void OnGestureEvent(ui::GestureEvent* event) OVERRIDE;
57 
58  private:
59   base::string16 accessible_name_;
60   bool has_capture_;
61 
62   DISALLOW_COPY_AND_ASSIGN(ActionableView);
63 };
64 
65 }  // namespace internal
66 }  // namespace ash
67 
68 #endif  // ASH_SYSTEM_TRAY_ACTIONABLE_VIEW_H_
69