1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef UI_AURA_CLIENT_CAPTURE_CLIENT_H_
#define UI_AURA_CLIENT_CAPTURE_CLIENT_H_
#include "ui/aura/aura_export.h"
namespace aura {
class Window;
namespace client {
class CaptureClientObserver;
// An interface implemented by an object that manages input capture.
//
// The intended semantics of window-capture are that:
// * At most one window on the system can register as "capturing" input.
// * If a window is capturing input, then all input events will get routed to
// this window.
// * The window may choose to release capture while processing an event. The
// resulting behavior is platform dependent (e.g. whether the event is
// redispatched to the window server).
class AURA_EXPORT CaptureClient {
public:
// 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 void AddObserver(CaptureClientObserver* observer) = 0;
virtual void RemoveObserver(CaptureClientObserver* observer) = 0;
protected:
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 client
} // namespace aura
#endif // UI_AURA_CLIENT_CAPTURE_CLIENT_H_
|
