athena/wm/public/window_list_provider.h

   1 // Copyright 2014 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 ATHENA_WM_PUBLIC_WINDOW_LIST_PROVIDER_H_
   6 #define ATHENA_WM_PUBLIC_WINDOW_LIST_PROVIDER_H_
   7
   8 #include "athena/athena_export.h"
   9 #include "ui/aura/window.h"
  10
  11 namespace athena {
  12
  13 class WindowListProviderObserver;
  14
  15 // Interface for an ordered list of aura::Window objects.
  16 // Note that lists returned by GetCurrentWindowList() will not change if any of
  17 // the other member functions will be called later.
  18 class ATHENA_EXPORT WindowListProvider {
  19  public:
  20   virtual ~WindowListProvider() {}
  21
  22   // Adding/removing an observer to status changes.
  23   virtual void AddObserver(WindowListProviderObserver* observer) = 0;
  24   virtual void RemoveObserver(WindowListProviderObserver* observer) = 0;
  25
  26   // Returns an ordered list of the current window configuration.
  27   virtual const aura::Window::Windows& GetWindowList() const = 0;
  28
  29   // Returns true if the |window| is part of the list.
  30   virtual bool IsWindowInList(aura::Window* window) const = 0;
  31
  32   // Returns true if the given window is a window which can be handled by the
  33   // WindowListProvider.
  34   virtual bool IsValidWindow(aura::Window* window) const = 0;
  35
  36   // Stacks a given |window| in direct front of a |reference_window|.
  37   // Note: The |window| and |reference_window| has to be in the list already.
  38   virtual void StackWindowFrontOf(aura::Window* window,
  39                                   aura::Window* reference_window) = 0;
  40
  41   // Stacks a given |window| directly behind a |reference_window|.
  42   // Note: The |window| and |reference_window| has to be in the list already.
  43   virtual void StackWindowBehindTo(aura::Window* window,
  44                                    aura::Window* reference_window) = 0;
  45 };
  46
  47 }  // namespace athena
  48
  49 #endif  // ATHENA_WM_PUBLIC_WINDOW_LIST_PROVIDER_H_