env.h revision 2a99a7e74a7f215066514fe81d2bfa6639d9eddd
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_AURA_ENV_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UI_AURA_ENV_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/scoped_ptr.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/message_loop.h" 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/observer_list.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/aura/aura_export.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/base/events/event_handler.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/base/events/event_target.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/gfx/point.h" 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(USE_X11) 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/aura/device_list_updater_aurax11.h" 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace aura { 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class EnvObserver; 222a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class RootWindow; 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Window; 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if !defined(USE_X11) 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Creates a platform-specific native event dispatcher. 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)MessageLoop::Dispatcher* CreateDispatcher(); 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A singleton object that tracks general state within Aura. 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// TODO(beng): manage RootWindows. 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class AURA_EXPORT Env : public ui::EventTarget { 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Env(); 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~Env(); 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static Env* GetInstance(); 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void DeleteInstance(); 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AddObserver(EnvObserver* observer); 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void RemoveObserver(EnvObserver* observer); 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_mouse_button_down() const { return mouse_button_flags_ != 0; } 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_mouse_button_flags(int mouse_button_flags) { 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) mouse_button_flags_ = mouse_button_flags; 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Gets/sets the last mouse location seen in a mouse event in the screen 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // coordinates. 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const gfx::Point& last_mouse_location() const { return last_mouse_location_; } 512a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void set_last_mouse_location(const gfx::Point& last_mouse_location) { 522a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) last_mouse_location_ = last_mouse_location; 532a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Whether any touch device is currently down. 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_touch_down() const { return is_touch_down_; } 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_touch_down(bool value) { is_touch_down_ = value; } 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Whether RenderWidgetHostViewAura::OnPaint() should paint white background 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // when backing store is not present. Default is true. 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // In some cases when page is using transparent background painting white 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // background before backing store is initialized causes a white splash. 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool render_white_bg() const { return render_white_bg_; } 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_render_white_bg(bool value) { render_white_bg_ = value; } 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the native event dispatcher. The result should only be passed to 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // base::RunLoop(dispatcher), or used to dispatch an event by 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |Dispatch(const NativeEvent&)| on it. It must never be stored. 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if !defined(OS_MACOSX) 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MessageLoop::Dispatcher* GetDispatcher(); 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Invoked by RootWindow when its host is activated. 742a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void RootWindowActivated(RootWindow* root_window); 752a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class Window; 782a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) friend class RootWindow; 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Init(); 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called by the Window when it is initialized. Notifies observers. 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void NotifyWindowInitialized(Window* window); 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 852a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called by the RootWindow when it is initialized. Notifies observers. 862a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void NotifyRootWindowInitialized(RootWindow* root_window); 872a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Overridden from ui::EventTarget: 892a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual bool CanAcceptEvent(const ui::Event& event) OVERRIDE; 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ui::EventTarget* GetParentTarget() OVERRIDE; 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ObserverList<EnvObserver> observers_; 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if !defined(USE_X11) 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<MessageLoop::Dispatcher> dispatcher_; 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static Env* instance_; 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int mouse_button_flags_; 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Location of last mouse event, in screen coordinates. 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) gfx::Point last_mouse_location_; 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_touch_down_; 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool render_white_bg_; 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(USE_X11) 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DeviceListUpdaterAuraX11 device_list_updater_aurax11_; 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(Env); 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace aura 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // UI_AURA_ENV_H_ 114