blob: c04a93590326d1fe1e7077529c7bd987078d7fe8 [file] [log] [blame]
Jeff Brown928e0542011-01-10 11:17:36 -08001/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef _UI_INPUT_APPLICATION_H
18#define _UI_INPUT_APPLICATION_H
19
Mathias Agopianb93a03f82012-02-17 15:34:57 -080020#include <androidfw/Input.h>
Jeff Brown928e0542011-01-10 11:17:36 -080021
22#include <utils/RefBase.h>
23#include <utils/Timers.h>
24#include <utils/String8.h>
25
26namespace android {
27
28/*
Jeff Brown9302c872011-07-13 22:51:29 -070029 * Describes the properties of an application that can receive input.
Jeff Browncc4f7db2011-08-30 20:34:48 -070030 */
31struct InputApplicationInfo {
32 String8 name;
33 nsecs_t dispatchingTimeout;
34};
35
36
37/*
38 * Handle for an application that can receive input.
Jeff Brown9302c872011-07-13 22:51:29 -070039 *
40 * Used by the native input dispatcher as a handle for the window manager objects
Jeff Brown928e0542011-01-10 11:17:36 -080041 * that describe an application.
42 */
43class InputApplicationHandle : public RefBase {
Jeff Brown9302c872011-07-13 22:51:29 -070044public:
Jeff Browncc4f7db2011-08-30 20:34:48 -070045 inline const InputApplicationInfo* getInfo() const {
46 return mInfo;
47 }
48
49 inline String8 getName() const {
50 return mInfo ? mInfo->name : String8("<invalid>");
51 }
52
53 inline nsecs_t getDispatchingTimeout(nsecs_t defaultValue) const {
54 return mInfo ? mInfo->dispatchingTimeout : defaultValue;
55 }
Jeff Brown9302c872011-07-13 22:51:29 -070056
57 /**
58 * Requests that the state of this object be updated to reflect
59 * the most current available information about the application.
60 *
61 * This method should only be called from within the input dispatcher's
62 * critical section.
63 *
64 * Returns true on success, or false if the handle is no longer valid.
65 */
Jeff Browncc4f7db2011-08-30 20:34:48 -070066 virtual bool updateInfo() = 0;
67
68 /**
69 * Releases the storage used by the associated information when it is
70 * no longer needed.
71 */
72 void releaseInfo();
Jeff Brown9302c872011-07-13 22:51:29 -070073
Jeff Brown928e0542011-01-10 11:17:36 -080074protected:
Jeff Browncc4f7db2011-08-30 20:34:48 -070075 InputApplicationHandle();
76 virtual ~InputApplicationHandle();
77
78 InputApplicationInfo* mInfo;
Jeff Brown928e0542011-01-10 11:17:36 -080079};
80
Jeff Brown928e0542011-01-10 11:17:36 -080081} // namespace android
82
83#endif // _UI_INPUT_APPLICATION_H