• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright (c) 2012 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 UI_AURA_ENV_H_
6 #define UI_AURA_ENV_H_
7 
8 #include "base/memory/scoped_ptr.h"
9 #include "base/message_loop/message_loop.h"
10 #include "base/observer_list.h"
11 #include "ui/aura/aura_export.h"
12 #include "ui/events/event_handler.h"
13 #include "ui/events/event_target.h"
14 #include "ui/gfx/point.h"
15 
16 #if defined(USE_X11)
17 #include "ui/aura/device_list_updater_aurax11.h"
18 #endif
19 
20 namespace aura {
21 
22 namespace test {
23 class EnvTestHelper;
24 }
25 
26 class EnvObserver;
27 class InputStateLookup;
28 class RootWindow;
29 class Window;
30 
31 #if !defined(OS_MACOSX) && !defined(OS_ANDROID) && !defined(USE_X11)
32 // Creates a platform-specific native event dispatcher.
33 base::MessageLoop::Dispatcher* CreateDispatcher();
34 #endif
35 
36 // A singleton object that tracks general state within Aura.
37 // TODO(beng): manage RootWindows.
38 class AURA_EXPORT Env : public ui::EventTarget {
39  public:
40   Env();
41   virtual ~Env();
42 
43   static void CreateInstance();
44   static Env* GetInstance();
45   static void DeleteInstance();
46 
47   void AddObserver(EnvObserver* observer);
48   void RemoveObserver(EnvObserver* observer);
49 
set_mouse_button_flags(int mouse_button_flags)50   void set_mouse_button_flags(int mouse_button_flags) {
51     mouse_button_flags_ = mouse_button_flags;
52   }
53   // Returns true if a mouse button is down. This may query the native OS,
54   // otherwise it uses |mouse_button_flags_|.
55   bool IsMouseButtonDown() const;
56 
57   // Gets/sets the last mouse location seen in a mouse event in the screen
58   // coordinates.
last_mouse_location()59   const gfx::Point& last_mouse_location() const { return last_mouse_location_; }
set_last_mouse_location(const gfx::Point & last_mouse_location)60   void set_last_mouse_location(const gfx::Point& last_mouse_location) {
61     last_mouse_location_ = last_mouse_location;
62   }
63 
64   // Whether any touch device is currently down.
is_touch_down()65   bool is_touch_down() const { return is_touch_down_; }
set_touch_down(bool value)66   void set_touch_down(bool value) { is_touch_down_ = value; }
67 
68   // Returns the native event dispatcher. The result should only be passed to
69   // base::RunLoop(dispatcher), or used to dispatch an event by
70   // |Dispatch(const NativeEvent&)| on it. It must never be stored.
71 #if !defined(OS_MACOSX) && !defined(OS_ANDROID) && \
72     !defined(USE_GTK_MESSAGE_PUMP)
73   base::MessageLoop::Dispatcher* GetDispatcher();
74 #endif
75 
76   // Invoked by RootWindow when its host is activated.
77   void RootWindowActivated(RootWindow* root_window);
78 
79  private:
80   friend class test::EnvTestHelper;
81   friend class Window;
82   friend class RootWindow;
83 
84   void Init();
85 
86   // Called by the Window when it is initialized. Notifies observers.
87   void NotifyWindowInitialized(Window* window);
88 
89   // Called by the RootWindow when it is initialized. Notifies observers.
90   void NotifyRootWindowInitialized(RootWindow* root_window);
91 
92   // Overridden from ui::EventTarget:
93   virtual bool CanAcceptEvent(const ui::Event& event) OVERRIDE;
94   virtual ui::EventTarget* GetParentTarget() OVERRIDE;
95   virtual scoped_ptr<ui::EventTargetIterator> GetChildIterator() const OVERRIDE;
96   virtual ui::EventTargeter* GetEventTargeter() OVERRIDE;
97 
98   ObserverList<EnvObserver> observers_;
99 #if !defined(OS_MACOSX) && !defined(OS_ANDROID) && !defined(USE_X11)
100   scoped_ptr<base::MessageLoop::Dispatcher> dispatcher_;
101 #endif
102 
103   static Env* instance_;
104   int mouse_button_flags_;
105   // Location of last mouse event, in screen coordinates.
106   gfx::Point last_mouse_location_;
107   bool is_touch_down_;
108 
109 #if defined(USE_X11)
110   DeviceListUpdaterAuraX11 device_list_updater_aurax11_;
111 #endif
112 
113   scoped_ptr<InputStateLookup> input_state_lookup_;
114 
115   DISALLOW_COPY_AND_ASSIGN(Env);
116 };
117 
118 }  // namespace aura
119 
120 #endif  // UI_AURA_ENV_H_
121