display_controller.h revision 5821806d5e7f356e8fa4b058a389a808ea183019
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 ASH_DISPLAY_DISPLAY_CONTROLLER_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define ASH_DISPLAY_DISPLAY_CONTROLLER_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <map> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <vector> 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ash/ash_export.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/compiler_specific.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/gtest_prod_util.h" 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/observer_list.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/aura/display_observer.h" 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/aura/display_manager.h" 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/gfx/display.h" 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace aura { 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Display; 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class RootWindow; 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace base { 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Value; 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)template <typename T> class JSONValueConverter; 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace ash { 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace internal { 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class RootWindowController; 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct ASH_EXPORT DisplayLayout { 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Layout options where the secondary display should be positioned. 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum Position { 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TOP, 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) RIGHT, 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BOTTOM, 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LEFT 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DisplayLayout(); 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DisplayLayout(Position position, int offset); 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns an inverted display layout. 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DisplayLayout Invert() const WARN_UNUSED_RESULT; 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Converter functions to/from base::Value. 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool ConvertFromValue(const base::Value& value, DisplayLayout* layout); 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool ConvertToValue(const DisplayLayout& layout, base::Value* value); 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This method is used by base::JSONValueConverter, you don't need to call 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // this directly. Instead consider using converter functions above. 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void RegisterJSONConverter( 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::JSONValueConverter<DisplayLayout>* converter); 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Position position; 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The offset of the position of the secondary display. The offset is 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // based on the top/left edge of the primary display. 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int offset; 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns string representation of the layout for debugging/testing. 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string ToString() const; 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// DisplayController owns and maintains RootWindows for each attached 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// display, keeping them in sync with display configuration changes. 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ASH_EXPORT DisplayController : public aura::DisplayObserver { 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class ASH_EXPORT Observer { 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Invoked when the display configuration change is requested, 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // but before the change is applied to aura/ash. 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnDisplayConfigurationChanging() = 0; 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~Observer() {} 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DisplayController(); 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~DisplayController(); 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Gets primary display. This information is stored in global 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // object as this can be accessed after Shell is closed. 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const gfx::Display& GetPrimaryDisplay(); 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Initializes primary display. 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void InitPrimaryDisplay(); 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Initialize secondary displays. 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void InitSecondaryDisplays(); 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Add/Remove observers. 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AddObserver(Observer* observer); 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void RemoveObserver(Observer* observer); 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the root window for primary display. 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) aura::RootWindow* GetPrimaryRootWindow(); 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the root window for |display_id|. 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) aura::RootWindow* GetRootWindowForDisplayId(int64 id); 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sets the ID of the primary display. If the display is not connected, it 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // will switch the primary display when connected. 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetPrimaryDisplayId(int64 id); 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sets primary display. This re-assigns the current root 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // window to given |display|. 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetPrimaryDisplay(const gfx::Display& display); 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the secondary display. 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) gfx::Display* GetSecondaryDisplay(); 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Closes all child windows in the all root windows. 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CloseChildWindows(); 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns all root windows. In non extended desktop mode, this 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // returns the primary root window only. 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::vector<aura::RootWindow*> GetAllRootWindows(); 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns all oot window controllers. In non extended desktop 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // mode, this return a RootWindowController for the primary root window only. 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::vector<internal::RootWindowController*> GetAllRootWindowControllers(); 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the current overscan insets for the specified |display_id|. See 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // multi_display_manager.h for the details. 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) gfx::Insets GetOverscanInsets(int64 display_id) const; 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const DisplayLayout& default_display_layout() const { 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return default_display_layout_; 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetDefaultDisplayLayout(const DisplayLayout& layout); 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sets/gets the display layout for the specified display or display 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // name. Getter returns the default value in case it doesn't have 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // its own layout yet. 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetLayoutForDisplayName(const std::string& name, 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const DisplayLayout& layout); 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const DisplayLayout& GetLayoutForDisplay(const gfx::Display& display) const; 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the display layout used for current secondary display. 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const DisplayLayout& GetCurrentDisplayLayout() const; 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // aura::DisplayObserver overrides: 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnDisplayBoundsChanged( 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const gfx::Display& display) OVERRIDE; 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnDisplayAdded(const gfx::Display& display) OVERRIDE; 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnDisplayRemoved(const gfx::Display& display) OVERRIDE; 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Creates a root window for |display| and stores it in the |root_windows_| 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // map. 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) aura::RootWindow* AddRootWindowForDisplay(const gfx::Display& display); 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void UpdateDisplayBoundsForLayout(); 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void NotifyDisplayConfigurationChanging(); 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The mapping from display ID to its root window. 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::map<int64, aura::RootWindow*> root_windows_; 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The default display layout. 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DisplayLayout default_display_layout_; 1675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Per-device display layout. 1695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::map<std::string, DisplayLayout> secondary_layouts_; 1705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The ID of the display which should be primary when connected. 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // kInvalidDisplayID if no such preference is specified. 1735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int64 desired_primary_display_id_; 1745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ObserverList<Observer> observers_; 1765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(DisplayController); 1785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace ash 1815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // ASH_DISPLAY_DISPLAY_CONTROLLER_H_ 183