blob: 6d27a29d6572be00e110053b388f0c8bbdbe6a69 [file] [log] [blame]
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "ui/aura/aura_export.h"
namespace aura {
class Window;
namespace client {
// An interface implemented by an object that manages input capture.
class AURA_EXPORT CaptureClient {
// Does a capture on the |window|.
virtual void SetCapture(Window* window) = 0;
// Releases a capture from the |window|.
virtual void ReleaseCapture(Window* window) = 0;
// Returns the current capture window. This may only return a Window if the
// Window that has capture is a child of the Window the CaptureClient is
// installed on. GetGlobalCaptureWindow() can be used to locate the Window
// that has capture regardless of the Window the CaptureClient is installed
// on.
virtual Window* GetCaptureWindow() = 0;
// See description of GetCaptureWindow() for details.
virtual Window* GetGlobalCaptureWindow() = 0;
virtual ~CaptureClient() {}
// Sets/Gets the capture client on the root Window.
AURA_EXPORT void SetCaptureClient(Window* root_window,
CaptureClient* client);
AURA_EXPORT CaptureClient* GetCaptureClient(Window* root_window);
// A utility function to get the current capture window. Returns NULL
// if the window doesn't have a root window, or there is no capture window.
AURA_EXPORT Window* GetCaptureWindow(Window* window);
} // namespace clients
} // namespace aura