summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--cmds/atrace/atrace.cpp24
-rw-r--r--cmds/dumpstate/dumpstate.c32
-rw-r--r--data/etc/android.hardware.audio.pro.xml22
-rw-r--r--docs/Doxyfile1902
-rw-r--r--docs/Makefile13
-rw-r--r--docs/footer.jd0
-rw-r--r--docs/header.jd3
-rw-r--r--include/android/asset_manager.h42
-rw-r--r--include/android/asset_manager_jni.h10
-rw-r--r--include/android/bitmap.h46
-rw-r--r--include/android/configuration.h312
-rw-r--r--include/android/input.h850
-rw-r--r--include/android/keycodes.h435
-rw-r--r--include/android/looper.h35
-rw-r--r--include/android/native_activity.h52
-rw-r--r--include/android/native_window.h36
-rw-r--r--include/android/native_window_jni.h11
-rw-r--r--include/android/obb.h13
-rw-r--r--include/android/rect.h21
-rw-r--r--include/android/sensor.h147
-rw-r--r--include/android/storage_manager.h43
-rw-r--r--include/android/window.h166
-rw-r--r--include/batteryservice/BatteryService.h1
-rw-r--r--include/gui/SensorManager.h53
-rw-r--r--include/input/InputEventLabels.h5
-rw-r--r--include/ui/DisplayInfo.h1
-rw-r--r--libs/binder/ProcessState.cpp7
-rw-r--r--libs/gui/IGraphicBufferProducer.cpp6
-rw-r--r--libs/gui/Sensor.cpp4
-rw-r--r--libs/gui/SensorManager.cpp72
-rw-r--r--libs/input/InputTransport.cpp13
-rw-r--r--services/batteryservice/BatteryProperties.cpp2
-rw-r--r--services/inputflinger/InputReader.cpp6
-rw-r--r--services/surfaceflinger/DisplayHardware/HWComposer.cpp27
-rw-r--r--services/surfaceflinger/DisplayHardware/HWComposer.h1
-rw-r--r--services/surfaceflinger/SurfaceFlinger.cpp53
-rw-r--r--services/surfaceflinger/SurfaceFlinger.h1
-rw-r--r--services/surfaceflinger/surfaceflinger.rc1
38 files changed, 4087 insertions, 381 deletions
diff --git a/cmds/atrace/atrace.cpp b/cmds/atrace/atrace.cpp
index 3b4ccab15..3c9d899df 100644
--- a/cmds/atrace/atrace.cpp
+++ b/cmds/atrace/atrace.cpp
@@ -278,9 +278,27 @@ static bool appendStr(const char* filename, const char* str)
278static void writeClockSyncMarker() 278static void writeClockSyncMarker()
279{ 279{
280 char buffer[128]; 280 char buffer[128];
281 int len = 0;
282 int fd = open(k_traceMarkerPath, O_WRONLY);
283 if (fd == -1) {
284 fprintf(stderr, "error opening %s: %s (%d)\n", k_traceMarkerPath,
285 strerror(errno), errno);
286 return;
287 }
281 float now_in_seconds = systemTime(CLOCK_MONOTONIC) / 1000000000.0f; 288 float now_in_seconds = systemTime(CLOCK_MONOTONIC) / 1000000000.0f;
282 snprintf(buffer, 128, "trace_event_clock_sync: parent_ts=%f\n", now_in_seconds); 289
283 writeStr(k_traceMarkerPath, buffer); 290 len = snprintf(buffer, 128, "trace_event_clock_sync: parent_ts=%f\n", now_in_seconds);
291 if (write(fd, buffer, len) != len) {
292 fprintf(stderr, "error writing clock sync marker %s (%d)\n", strerror(errno), errno);
293 }
294
295 int64_t realtime_in_ms = systemTime(CLOCK_REALTIME) / 1000000;
296 len = snprintf(buffer, 128, "trace_event_clock_sync: realtime_ts=%" PRId64 "\n", realtime_in_ms);
297 if (write(fd, buffer, len) != len) {
298 fprintf(stderr, "error writing clock sync marker %s (%d)\n", strerror(errno), errno);
299 }
300
301 close(fd);
284} 302}
285 303
286// Enable or disable a kernel option by writing a "1" or a "0" into a /sys 304// Enable or disable a kernel option by writing a "1" or a "0" into a /sys
@@ -707,7 +725,6 @@ static bool startTrace()
707// Disable tracing in the kernel. 725// Disable tracing in the kernel.
708static void stopTrace() 726static void stopTrace()
709{ 727{
710 writeClockSyncMarker();
711 setTracingEnabled(false); 728 setTracingEnabled(false);
712} 729}
713 730
@@ -983,6 +1000,7 @@ int main(int argc, char **argv)
983 // another. 1000 // another.
984 ok = clearTrace(); 1001 ok = clearTrace();
985 1002
1003 writeClockSyncMarker();
986 if (ok && !async) { 1004 if (ok && !async) {
987 // Sleep to allow the trace to be captured. 1005 // Sleep to allow the trace to be captured.
988 struct timespec timeLeft; 1006 struct timespec timeLeft;
diff --git a/cmds/dumpstate/dumpstate.c b/cmds/dumpstate/dumpstate.c
index 9a13499db..0a393fd91 100644
--- a/cmds/dumpstate/dumpstate.c
+++ b/cmds/dumpstate/dumpstate.c
@@ -47,6 +47,7 @@ static char screenshot_path[PATH_MAX] = "";
47 47
48#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops" 48#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
49 49
50#define RAFT_DIR "/data/misc/raft/"
50#define TOMBSTONE_DIR "/data/tombstones" 51#define TOMBSTONE_DIR "/data/tombstones"
51#define TOMBSTONE_FILE_PREFIX TOMBSTONE_DIR "/tombstone_" 52#define TOMBSTONE_FILE_PREFIX TOMBSTONE_DIR "/tombstone_"
52/* Can accomodate a tombstone number up to 9999. */ 53/* Can accomodate a tombstone number up to 9999. */
@@ -359,6 +360,9 @@ static void dumpstate() {
359 360
360 run_command("LOG STATISTICS", 10, "logcat", "-b", "all", "-S", NULL); 361 run_command("LOG STATISTICS", 10, "logcat", "-b", "all", "-S", NULL);
361 362
363 // raft disabled as per http://b/24159112
364 // run_command("RAFT LOGS", 300, SU_PATH, "root", "logcompressor", "-r", RAFT_DIR, NULL);
365
362 /* show the traces we collected in main(), if that was done */ 366 /* show the traces we collected in main(), if that was done */
363 if (dump_traces_path != NULL) { 367 if (dump_traces_path != NULL) {
364 dump_file("VM TRACES JUST NOW", dump_traces_path); 368 dump_file("VM TRACES JUST NOW", dump_traces_path);
@@ -447,8 +451,6 @@ static void dumpstate() {
447 run_command("ARP CACHE", 10, "ip", "-4", "neigh", "show", NULL); 451 run_command("ARP CACHE", 10, "ip", "-4", "neigh", "show", NULL);
448 run_command("IPv6 ND CACHE", 10, "ip", "-6", "neigh", "show", NULL); 452 run_command("IPv6 ND CACHE", 10, "ip", "-6", "neigh", "show", NULL);
449 453
450 run_command("NETWORK DIAGNOSTICS", 10, "dumpsys", "connectivity", "--diag", NULL);
451
452 run_command("IPTABLES", 10, SU_PATH, "root", "iptables", "-L", "-nvx", NULL); 454 run_command("IPTABLES", 10, SU_PATH, "root", "iptables", "-L", "-nvx", NULL);
453 run_command("IP6TABLES", 10, SU_PATH, "root", "ip6tables", "-L", "-nvx", NULL); 455 run_command("IP6TABLES", 10, SU_PATH, "root", "ip6tables", "-L", "-nvx", NULL);
454 run_command("IPTABLE NAT", 10, SU_PATH, "root", "iptables", "-t", "nat", "-L", "-nvx", NULL); 456 run_command("IPTABLE NAT", 10, SU_PATH, "root", "iptables", "-t", "nat", "-L", "-nvx", NULL);
@@ -460,25 +462,29 @@ static void dumpstate() {
460 SU_PATH, "root", "wpa_cli", "IFNAME=wlan0", "list_networks", NULL); 462 SU_PATH, "root", "wpa_cli", "IFNAME=wlan0", "list_networks", NULL);
461 463
462#ifdef FWDUMP_bcmdhd 464#ifdef FWDUMP_bcmdhd
463 run_command("DUMP WIFI INTERNAL COUNTERS", 20, 465 run_command("ND OFFLOAD TABLE", 5,
466 SU_PATH, "root", "wlutil", "nd_hostip", NULL);
467
468 run_command("DUMP WIFI INTERNAL COUNTERS (1)", 20,
464 SU_PATH, "root", "wlutil", "counters", NULL); 469 SU_PATH, "root", "wlutil", "counters", NULL);
470
471 run_command("ND OFFLOAD STATUS (1)", 5,
472 SU_PATH, "root", "wlutil", "nd_status", NULL);
473
465#endif 474#endif
466 dump_file("INTERRUPTS (1)", "/proc/interrupts"); 475 dump_file("INTERRUPTS (1)", "/proc/interrupts");
467 476
468 property_get("dhcp.wlan0.gateway", network, ""); 477 run_command("NETWORK DIAGNOSTICS", 10, "dumpsys", "connectivity", "--diag", NULL);
469 if (network[0]) 478
470 run_command("PING GATEWAY", 10, "ping", "-c", "3", "-i", ".5", network, NULL);
471 property_get("dhcp.wlan0.dns1", network, "");
472 if (network[0])
473 run_command("PING DNS1", 10, "ping", "-c", "3", "-i", ".5", network, NULL);
474 property_get("dhcp.wlan0.dns2", network, "");
475 if (network[0])
476 run_command("PING DNS2", 10, "ping", "-c", "3", "-i", ".5", network, NULL);
477#ifdef FWDUMP_bcmdhd 479#ifdef FWDUMP_bcmdhd
478 run_command("DUMP WIFI STATUS", 20, 480 run_command("DUMP WIFI STATUS", 20,
479 SU_PATH, "root", "dhdutil", "-i", "wlan0", "dump", NULL); 481 SU_PATH, "root", "dhdutil", "-i", "wlan0", "dump", NULL);
480 run_command("DUMP WIFI INTERNAL COUNTERS", 20, 482
483 run_command("DUMP WIFI INTERNAL COUNTERS (2)", 20,
481 SU_PATH, "root", "wlutil", "counters", NULL); 484 SU_PATH, "root", "wlutil", "counters", NULL);
485
486 run_command("ND OFFLOAD STATUS (2)", 5,
487 SU_PATH, "root", "wlutil", "nd_status", NULL);
482#endif 488#endif
483 dump_file("INTERRUPTS (2)", "/proc/interrupts"); 489 dump_file("INTERRUPTS (2)", "/proc/interrupts");
484 490
diff --git a/data/etc/android.hardware.audio.pro.xml b/data/etc/android.hardware.audio.pro.xml
new file mode 100644
index 000000000..5328d415c
--- /dev/null
+++ b/data/etc/android.hardware.audio.pro.xml
@@ -0,0 +1,22 @@
1<?xml version="1.0" encoding="utf-8"?>
2<!-- Copyright (C) 2015 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<!-- This is the feature indicating professional audio, as specified by the
18 CDD. ONLY devices that meet the CDD's requirements may declare this
19 feature. -->
20<permissions>
21 <feature name="android.hardware.audio.pro" />
22</permissions>
diff --git a/docs/Doxyfile b/docs/Doxyfile
new file mode 100644
index 000000000..46d6d846d
--- /dev/null
+++ b/docs/Doxyfile
@@ -0,0 +1,1902 @@
1# Doxyfile 1.8.3.1
2
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project
5#
6# All text after a hash (#) is considered a comment and will be ignored
7# The format is:
8# TAG = value [value, ...]
9# For lists items can also be appended using:
10# TAG += value [value, ...]
11# Values that contain spaces should be placed between quotes (" ")
12
13#---------------------------------------------------------------------------
14# Project related configuration options
15#---------------------------------------------------------------------------
16
17# This tag specifies the encoding used for all characters in the config file
18# that follow. The default is UTF-8 which is also the encoding used for all
19# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20# iconv built into libc) for the transcoding. See
21# http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23DOXYFILE_ENCODING = UTF-8
24
25# The PROJECT_NAME tag is a single word (or sequence of words) that should
26# identify the project. Note that if you do not use Doxywizard you need
27# to put quotes around the project name if it contains spaces.
28
29PROJECT_NAME = "NDK API"
30
31# The PROJECT_NUMBER tag can be used to enter a project or revision number.
32# This could be handy for archiving the generated documentation or
33# if some version control system is used.
34
35PROJECT_NUMBER =
36
37# Using the PROJECT_BRIEF tag one can provide an optional one line description
38# for a project that appears at the top of each page and should give viewer
39# a quick idea about the purpose of the project. Keep the description short.
40
41PROJECT_BRIEF = ""
42
43# With the PROJECT_LOGO tag one can specify an logo or icon that is
44# included in the documentation. The maximum height of the logo should not
45# exceed 55 pixels and the maximum width should not exceed 200 pixels.
46# Doxygen will copy the logo to the output directory.
47
48PROJECT_LOGO = logo.png
49
50# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
51# base path where the generated documentation will be put.
52# If a relative path is entered, it will be relative to the location
53# where doxygen was started. If left blank the current directory will be used.
54
55OUTPUT_DIRECTORY =
56
57# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
58# 4096 sub-directories (in 2 levels) under the output directory of each output
59# format and will distribute the generated files over these directories.
60# Enabling this option can be useful when feeding doxygen a huge amount of
61# source files, where putting all generated files in the same directory would
62# otherwise cause performance problems for the file system.
63
64CREATE_SUBDIRS = NO
65
66# The OUTPUT_LANGUAGE tag is used to specify the language in which all
67# documentation generated by doxygen is written. Doxygen will use this
68# information to generate all constant output in the proper language.
69# The default language is English, other supported languages are:
70# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
71# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
72# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
73# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
74# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
75# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
76
77OUTPUT_LANGUAGE = English
78
79# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
80# include brief member descriptions after the members that are listed in
81# the file and class documentation (similar to JavaDoc).
82# Set to NO to disable this.
83
84BRIEF_MEMBER_DESC = YES
85
86# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
87# the brief description of a member or function before the detailed description.
88# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
89# brief descriptions will be completely suppressed.
90
91REPEAT_BRIEF = YES
92
93# This tag implements a quasi-intelligent brief description abbreviator
94# that is used to form the text in various listings. Each string
95# in this list, if found as the leading text of the brief description, will be
96# stripped from the text and the result after processing the whole list, is
97# used as the annotated text. Otherwise, the brief description is used as-is.
98# If left blank, the following values are used ("$name" is automatically
99# replaced with the name of the entity): "The $name class" "The $name widget"
100# "The $name file" "is" "provides" "specifies" "contains"
101# "represents" "a" "an" "the"
102
103ABBREVIATE_BRIEF = "The $name class" \
104 "The $name widget" \
105 "The $name file" \
106 is \
107 provides \
108 specifies \
109 contains \
110 represents \
111 a \
112 an \
113 the
114
115# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
116# Doxygen will generate a detailed section even if there is only a brief
117# description.
118
119ALWAYS_DETAILED_SEC = NO
120
121# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
122# inherited members of a class in the documentation of that class as if those
123# members were ordinary class members. Constructors, destructors and assignment
124# operators of the base classes will not be shown.
125
126INLINE_INHERITED_MEMB = NO
127
128# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
129# path before files name in the file list and in the header files. If set
130# to NO the shortest path that makes the file name unique will be used.
131
132FULL_PATH_NAMES = NO
133
134# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
135# can be used to strip a user-defined part of the path. Stripping is
136# only done if one of the specified strings matches the left-hand part of
137# the path. The tag can be used to show relative paths in the file list.
138# If left blank the directory from which doxygen is run is used as the
139# path to strip. Note that you specify absolute paths here, but also
140# relative paths, which will be relative from the directory where doxygen is
141# started.
142
143STRIP_FROM_PATH =
144
145# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
146# the path mentioned in the documentation of a class, which tells
147# the reader which header file to include in order to use a class.
148# If left blank only the name of the header file containing the class
149# definition is used. Otherwise one should specify the include paths that
150# are normally passed to the compiler using the -I flag.
151
152STRIP_FROM_INC_PATH =
153
154# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
155# (but less readable) file names. This can be useful if your file system
156# doesn't support long names like on DOS, Mac, or CD-ROM.
157
158SHORT_NAMES = NO
159
160# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
161# will interpret the first line (until the first dot) of a JavaDoc-style
162# comment as the brief description. If set to NO, the JavaDoc
163# comments will behave just like regular Qt-style comments
164# (thus requiring an explicit @brief command for a brief description.)
165
166JAVADOC_AUTOBRIEF = NO
167
168# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
169# interpret the first line (until the first dot) of a Qt-style
170# comment as the brief description. If set to NO, the comments
171# will behave just like regular Qt-style comments (thus requiring
172# an explicit \brief command for a brief description.)
173
174QT_AUTOBRIEF = NO
175
176# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
177# treat a multi-line C++ special comment block (i.e. a block of //! or ///
178# comments) as a brief description. This used to be the default behaviour.
179# The new default is to treat a multi-line C++ comment block as a detailed
180# description. Set this tag to YES if you prefer the old behaviour instead.
181
182MULTILINE_CPP_IS_BRIEF = NO
183
184# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
185# member inherits the documentation from any documented member that it
186# re-implements.
187
188INHERIT_DOCS = YES
189
190# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
191# a new page for each member. If set to NO, the documentation of a member will
192# be part of the file/class/namespace that contains it.
193
194SEPARATE_MEMBER_PAGES = NO
195
196# The TAB_SIZE tag can be used to set the number of spaces in a tab.
197# Doxygen uses this value to replace tabs by spaces in code fragments.
198
199TAB_SIZE = 4
200
201# This tag can be used to specify a number of aliases that acts
202# as commands in the documentation. An alias has the form "name=value".
203# For example adding "sideeffect=\par Side Effects:\n" will allow you to
204# put the command \sideeffect (or @sideeffect) in the documentation, which
205# will result in a user-defined paragraph with heading "Side Effects:".
206# You can put \n's in the value part of an alias to insert newlines.
207
208ALIASES =
209
210# This tag can be used to specify a number of word-keyword mappings (TCL only).
211# A mapping has the form "name=value". For example adding
212# "class=itcl::class" will allow you to use the command class in the
213# itcl::class meaning.
214
215TCL_SUBST =
216
217# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
218# sources only. Doxygen will then generate output that is more tailored for C.
219# For instance, some of the names that are used will be different. The list
220# of all members will be omitted, etc.
221
222OPTIMIZE_OUTPUT_FOR_C = YES
223
224# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
225# sources only. Doxygen will then generate output that is more tailored for
226# Java. For instance, namespaces will be presented as packages, qualified
227# scopes will look different, etc.
228
229OPTIMIZE_OUTPUT_JAVA = NO
230
231# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
232# sources only. Doxygen will then generate output that is more tailored for
233# Fortran.
234
235OPTIMIZE_FOR_FORTRAN = NO
236
237# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
238# sources. Doxygen will then generate output that is tailored for
239# VHDL.
240
241OPTIMIZE_OUTPUT_VHDL = NO
242
243# Doxygen selects the parser to use depending on the extension of the files it
244# parses. With this tag you can assign which parser to use for a given
245# extension. Doxygen has a built-in mapping, but you can override or extend it
246# using this tag. The format is ext=language, where ext is a file extension,
247# and language is one of the parsers supported by doxygen: IDL, Java,
248# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
249# C++. For instance to make doxygen treat .inc files as Fortran files (default
250# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
251# that for custom extensions you also need to set FILE_PATTERNS otherwise the
252# files are not read by doxygen.
253
254EXTENSION_MAPPING =
255
256# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
257# comments according to the Markdown format, which allows for more readable
258# documentation. See http://daringfireball.net/projects/markdown/ for details.
259# The output of markdown processing is further processed by doxygen, so you
260# can mix doxygen, HTML, and XML commands with Markdown formatting.
261# Disable only in case of backward compatibilities issues.
262
263MARKDOWN_SUPPORT = YES
264
265# When enabled doxygen tries to link words that correspond to documented classes,
266# or namespaces to their corresponding documentation. Such a link can be
267# prevented in individual cases by by putting a % sign in front of the word or
268# globally by setting AUTOLINK_SUPPORT to NO.
269
270AUTOLINK_SUPPORT = YES
271
272# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
273# to include (a tag file for) the STL sources as input, then you should
274# set this tag to YES in order to let doxygen match functions declarations and
275# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
276# func(std::string) {}). This also makes the inheritance and collaboration
277# diagrams that involve STL classes more complete and accurate.
278
279BUILTIN_STL_SUPPORT = NO
280
281# If you use Microsoft's C++/CLI language, you should set this option to YES to
282# enable parsing support.
283
284CPP_CLI_SUPPORT = NO
285
286# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
287# Doxygen will parse them like normal C++ but will assume all classes use public
288# instead of private inheritance when no explicit protection keyword is present.
289
290SIP_SUPPORT = NO
291
292# For Microsoft's IDL there are propget and propput attributes to indicate
293# getter and setter methods for a property. Setting this option to YES (the
294# default) will make doxygen replace the get and set methods by a property in
295# the documentation. This will only work if the methods are indeed getting or
296# setting a simple type. If this is not the case, or you want to show the
297# methods anyway, you should set this option to NO.
298
299IDL_PROPERTY_SUPPORT = YES
300
301# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
302# tag is set to YES, then doxygen will reuse the documentation of the first
303# member in the group (if any) for the other members of the group. By default
304# all members of a group must be documented explicitly.
305
306DISTRIBUTE_GROUP_DOC = NO
307
308# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
309# the same type (for instance a group of public functions) to be put as a
310# subgroup of that type (e.g. under the Public Functions section). Set it to
311# NO to prevent subgrouping. Alternatively, this can be done per class using
312# the \nosubgrouping command.
313
314SUBGROUPING = YES
315
316# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
317# unions are shown inside the group in which they are included (e.g. using
318# @ingroup) instead of on a separate page (for HTML and Man pages) or
319# section (for LaTeX and RTF).
320
321INLINE_GROUPED_CLASSES = NO
322
323# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
324# unions with only public data fields will be shown inline in the documentation
325# of the scope in which they are defined (i.e. file, namespace, or group
326# documentation), provided this scope is documented. If set to NO (the default),
327# structs, classes, and unions are shown on a separate page (for HTML and Man
328# pages) or section (for LaTeX and RTF).
329
330INLINE_SIMPLE_STRUCTS = NO
331
332# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
333# is documented as struct, union, or enum with the name of the typedef. So
334# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
335# with name TypeT. When disabled the typedef will appear as a member of a file,
336# namespace, or class. And the struct will be named TypeS. This can typically
337# be useful for C code in case the coding convention dictates that all compound
338# types are typedef'ed and only the typedef is referenced, never the tag name.
339
340TYPEDEF_HIDES_STRUCT = NO
341
342# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
343# determine which symbols to keep in memory and which to flush to disk.
344# When the cache is full, less often used symbols will be written to disk.
345# For small to medium size projects (<1000 input files) the default value is
346# probably good enough. For larger projects a too small cache size can cause
347# doxygen to be busy swapping symbols to and from disk most of the time
348# causing a significant performance penalty.
349# If the system has enough physical memory increasing the cache will improve the
350# performance by keeping more symbols in memory. Note that the value works on
351# a logarithmic scale so increasing the size by one will roughly double the
352# memory usage. The cache size is given by this formula:
353# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
354# corresponding to a cache size of 2^16 = 65536 symbols.
355
356SYMBOL_CACHE_SIZE = 0
357
358# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
359# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
360# their name and scope. Since this can be an expensive process and often the
361# same symbol appear multiple times in the code, doxygen keeps a cache of
362# pre-resolved symbols. If the cache is too small doxygen will become slower.
363# If the cache is too large, memory is wasted. The cache size is given by this
364# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
365# corresponding to a cache size of 2^16 = 65536 symbols.
366
367LOOKUP_CACHE_SIZE = 0
368
369#---------------------------------------------------------------------------
370# Build related configuration options
371#---------------------------------------------------------------------------
372
373# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
374# documentation are documented, even if no documentation was available.
375# Private class members and static file members will be hidden unless
376# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
377
378EXTRACT_ALL = YES
379
380# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
381# will be included in the documentation.
382
383EXTRACT_PRIVATE = NO
384
385# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
386# scope will be included in the documentation.
387
388EXTRACT_PACKAGE = NO
389
390# If the EXTRACT_STATIC tag is set to YES all static members of a file
391# will be included in the documentation.
392
393EXTRACT_STATIC = NO
394
395# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
396# defined locally in source files will be included in the documentation.
397# If set to NO only classes defined in header files are included.
398
399EXTRACT_LOCAL_CLASSES = YES
400
401# This flag is only useful for Objective-C code. When set to YES local
402# methods, which are defined in the implementation section but not in
403# the interface are included in the documentation.
404# If set to NO (the default) only methods in the interface are included.
405
406EXTRACT_LOCAL_METHODS = NO
407
408# If this flag is set to YES, the members of anonymous namespaces will be
409# extracted and appear in the documentation as a namespace called
410# 'anonymous_namespace{file}', where file will be replaced with the base
411# name of the file that contains the anonymous namespace. By default
412# anonymous namespaces are hidden.
413
414EXTRACT_ANON_NSPACES = NO
415
416# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
417# undocumented members of documented classes, files or namespaces.
418# If set to NO (the default) these members will be included in the
419# various overviews, but no documentation section is generated.
420# This option has no effect if EXTRACT_ALL is enabled.
421
422HIDE_UNDOC_MEMBERS = NO
423
424# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
425# undocumented classes that are normally visible in the class hierarchy.
426# If set to NO (the default) these classes will be included in the various
427# overviews. This option has no effect if EXTRACT_ALL is enabled.
428
429HIDE_UNDOC_CLASSES = NO
430
431# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
432# friend (class|struct|union) declarations.
433# If set to NO (the default) these declarations will be included in the
434# documentation.
435
436HIDE_FRIEND_COMPOUNDS = NO
437
438# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
439# documentation blocks found inside the body of a function.
440# If set to NO (the default) these blocks will be appended to the
441# function's detailed documentation block.
442
443HIDE_IN_BODY_DOCS = NO
444
445# The INTERNAL_DOCS tag determines if documentation
446# that is typed after a \internal command is included. If the tag is set
447# to NO (the default) then the documentation will be excluded.
448# Set it to YES to include the internal documentation.
449
450INTERNAL_DOCS = NO
451
452# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
453# file names in lower-case letters. If set to YES upper-case letters are also
454# allowed. This is useful if you have classes or files whose names only differ
455# in case and if your file system supports case sensitive file names. Windows
456# and Mac users are advised to set this option to NO.
457
458CASE_SENSE_NAMES = NO
459
460# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
461# will show members with their full class and namespace scopes in the
462# documentation. If set to YES the scope will be hidden.
463
464HIDE_SCOPE_NAMES = YES
465
466# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
467# will put a list of the files that are included by a file in the documentation
468# of that file.
469
470SHOW_INCLUDE_FILES = YES
471
472# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
473# will list include files with double quotes in the documentation
474# rather than with sharp brackets.
475
476FORCE_LOCAL_INCLUDES = NO
477
478# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
479# is inserted in the documentation for inline members.
480
481INLINE_INFO = YES
482
483# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
484# will sort the (detailed) documentation of file and class members
485# alphabetically by member name. If set to NO the members will appear in
486# declaration order.
487
488SORT_MEMBER_DOCS = YES
489
490# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
491# brief documentation of file, namespace and class members alphabetically
492# by member name. If set to NO (the default) the members will appear in
493# declaration order.
494
495SORT_BRIEF_DOCS = NO
496
497# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
498# will sort the (brief and detailed) documentation of class members so that
499# constructors and destructors are listed first. If set to NO (the default)
500# the constructors will appear in the respective orders defined by
501# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
502# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
503# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
504
505SORT_MEMBERS_CTORS_1ST = NO
506
507# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
508# hierarchy of group names into alphabetical order. If set to NO (the default)
509# the group names will appear in their defined order.
510
511SORT_GROUP_NAMES = NO
512
513# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
514# sorted by fully-qualified names, including namespaces. If set to
515# NO (the default), the class list will be sorted only by class name,
516# not including the namespace part.
517# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
518# Note: This option applies only to the class list, not to the
519# alphabetical list.
520
521SORT_BY_SCOPE_NAME = NO
522
523# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
524# do proper type resolution of all parameters of a function it will reject a
525# match between the prototype and the implementation of a member function even
526# if there is only one candidate or it is obvious which candidate to choose
527# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
528# will still accept a match between prototype and implementation in such cases.
529
530STRICT_PROTO_MATCHING = NO
531
532# The GENERATE_TODOLIST tag can be used to enable (YES) or
533# disable (NO) the todo list. This list is created by putting \todo
534# commands in the documentation.
535
536GENERATE_TODOLIST = YES
537
538# The GENERATE_TESTLIST tag can be used to enable (YES) or
539# disable (NO) the test list. This list is created by putting \test
540# commands in the documentation.
541
542GENERATE_TESTLIST = YES
543
544# The GENERATE_BUGLIST tag can be used to enable (YES) or
545# disable (NO) the bug list. This list is created by putting \bug
546# commands in the documentation.
547
548GENERATE_BUGLIST = YES
549
550# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
551# disable (NO) the deprecated list. This list is created by putting
552# \deprecated commands in the documentation.
553
554GENERATE_DEPRECATEDLIST= YES
555
556# The ENABLED_SECTIONS tag can be used to enable conditional
557# documentation sections, marked by \if section-label ... \endif
558# and \cond section-label ... \endcond blocks.
559
560ENABLED_SECTIONS =
561
562# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
563# the initial value of a variable or macro consists of for it to appear in
564# the documentation. If the initializer consists of more lines than specified
565# here it will be hidden. Use a value of 0 to hide initializers completely.
566# The appearance of the initializer of individual variables and macros in the
567# documentation can be controlled using \showinitializer or \hideinitializer
568# command in the documentation regardless of this setting.
569
570MAX_INITIALIZER_LINES = 26
571
572# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
573# at the bottom of the documentation of classes and structs. If set to YES the
574# list will mention the files that were used to generate the documentation.
575
576SHOW_USED_FILES = YES
577
578# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
579# This will remove the Files entry from the Quick Index and from the
580# Folder Tree View (if specified). The default is YES.
581
582SHOW_FILES = YES
583
584# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
585# Namespaces page. This will remove the Namespaces entry from the Quick Index
586# and from the Folder Tree View (if specified). The default is YES.
587
588SHOW_NAMESPACES = YES
589
590# The FILE_VERSION_FILTER tag can be used to specify a program or script that
591# doxygen should invoke to get the current version for each file (typically from
592# the version control system). Doxygen will invoke the program by executing (via
593# popen()) the command <command> <input-file>, where <command> is the value of
594# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
595# provided by doxygen. Whatever the program writes to standard output
596# is used as the file version. See the manual for examples.
597
598FILE_VERSION_FILTER =
599
600# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
601# by doxygen. The layout file controls the global structure of the generated
602# output files in an output format independent way. To create the layout file
603# that represents doxygen's defaults, run doxygen with the -l option.
604# You can optionally specify a file name after the option, if omitted
605# DoxygenLayout.xml will be used as the name of the layout file.
606
607LAYOUT_FILE =
608
609# The CITE_BIB_FILES tag can be used to specify one or more bib files
610# containing the references data. This must be a list of .bib files. The
611# .bib extension is automatically appended if omitted. Using this command
612# requires the bibtex tool to be installed. See also
613# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
614# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
615# feature you need bibtex and perl available in the search path. Do not use
616# file names with spaces, bibtex cannot handle them.
617
618CITE_BIB_FILES =
619
620#---------------------------------------------------------------------------
621# configuration options related to warning and progress messages
622#---------------------------------------------------------------------------
623
624# The QUIET tag can be used to turn on/off the messages that are generated
625# by doxygen. Possible values are YES and NO. If left blank NO is used.
626
627QUIET = NO
628
629# The WARNINGS tag can be used to turn on/off the warning messages that are
630# generated by doxygen. Possible values are YES and NO. If left blank
631# NO is used.
632
633WARNINGS = YES
634
635# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
636# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
637# automatically be disabled.
638
639WARN_IF_UNDOCUMENTED = YES
640
641# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
642# potential errors in the documentation, such as not documenting some
643# parameters in a documented function, or documenting parameters that
644# don't exist or using markup commands wrongly.
645
646WARN_IF_DOC_ERROR = YES
647
648# The WARN_NO_PARAMDOC option can be enabled to get warnings for
649# functions that are documented, but have no documentation for their parameters
650# or return value. If set to NO (the default) doxygen will only warn about
651# wrong or incomplete parameter documentation, but not about the absence of
652# documentation.
653
654WARN_NO_PARAMDOC = NO
655
656# The WARN_FORMAT tag determines the format of the warning messages that
657# doxygen can produce. The string should contain the $file, $line, and $text
658# tags, which will be replaced by the file and line number from which the
659# warning originated and the warning text. Optionally the format may contain
660# $version, which will be replaced by the version of the file (if it could
661# be obtained via FILE_VERSION_FILTER)
662
663WARN_FORMAT = "$file:$line: $text"
664
665# The WARN_LOGFILE tag can be used to specify a file to which warning
666# and error messages should be written. If left blank the output is written
667# to stderr.
668
669WARN_LOGFILE =
670
671#---------------------------------------------------------------------------
672# configuration options related to the input files
673#---------------------------------------------------------------------------
674
675# The INPUT tag can be used to specify the files and/or directories that contain
676# documented source files. You may enter file names like "myfile.cpp" or
677# directories like "/usr/src/myproject". Separate the files or directories
678# with spaces.
679
680INPUT = ../include/android
681
682# This tag can be used to specify the character encoding of the source files
683# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
684# also the default input encoding. Doxygen uses libiconv (or the iconv built
685# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
686# the list of possible encodings.
687
688INPUT_ENCODING = UTF-8
689
690# If the value of the INPUT tag contains directories, you can use the
691# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
692# and *.h) to filter out the source-files in the directories. If left
693# blank the following patterns are tested:
694# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
695# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
696# *.f90 *.f *.for *.vhd *.vhdl
697
698FILE_PATTERNS = *.c \
699 *.cc \
700 *.cxx \
701 *.cpp \
702 *.c++ \
703 *.d \
704 *.java \
705 *.ii \
706 *.ixx \
707 *.ipp \
708 *.i++ \
709 *.inl \
710 *.h \
711 *.hh \
712 *.hxx \
713 *.hpp \
714 *.h++ \
715 *.idl \
716 *.odl \
717 *.cs \
718 *.php \
719 *.php3 \
720 *.inc \
721 *.m \
722 *.markdown \
723 *.md \
724 *.mm \
725 *.dox \
726 *.py \
727 *.f90 \
728 *.f \
729 *.for \
730 *.vhd \
731 *.vhdl
732
733# The RECURSIVE tag can be used to turn specify whether or not subdirectories
734# should be searched for input files as well. Possible values are YES and NO.
735# If left blank NO is used.
736
737RECURSIVE = YES
738
739# The EXCLUDE tag can be used to specify files and/or directories that should be
740# excluded from the INPUT source files. This way you can easily exclude a
741# subdirectory from a directory tree whose root is specified with the INPUT tag.
742# Note that relative paths are relative to the directory from which doxygen is
743# run.
744
745EXCLUDE =
746
747# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
748# directories that are symbolic links (a Unix file system feature) are excluded
749# from the input.
750
751EXCLUDE_SYMLINKS = NO
752
753# If the value of the INPUT tag contains directories, you can use the
754# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
755# certain files from those directories. Note that the wildcards are matched
756# against the file with absolute path, so to exclude all test directories
757# for example use the pattern */test/*
758
759EXCLUDE_PATTERNS =
760
761# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
762# (namespaces, classes, functions, etc.) that should be excluded from the
763# output. The symbol name can be a fully qualified name, a word, or if the
764# wildcard * is used, a substring. Examples: ANamespace, AClass,
765# AClass::ANamespace, ANamespace::*Test
766
767EXCLUDE_SYMBOLS =
768
769# The EXAMPLE_PATH tag can be used to specify one or more files or
770# directories that contain example code fragments that are included (see
771# the \include command).
772
773EXAMPLE_PATH =
774
775# If the value of the EXAMPLE_PATH tag contains directories, you can use the
776# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
777# and *.h) to filter out the source-files in the directories. If left
778# blank all files are included.
779
780EXAMPLE_PATTERNS = *
781
782# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
783# searched for input files to be used with the \include or \dontinclude
784# commands irrespective of the value of the RECURSIVE tag.
785# Possible values are YES and NO. If left blank NO is used.
786
787EXAMPLE_RECURSIVE = NO
788
789# The IMAGE_PATH tag can be used to specify one or more files or
790# directories that contain image that are included in the documentation (see
791# the \image command).
792
793IMAGE_PATH =
794
795# The INPUT_FILTER tag can be used to specify a program that doxygen should
796# invoke to filter for each input file. Doxygen will invoke the filter program
797# by executing (via popen()) the command <filter> <input-file>, where <filter>
798# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
799# input file. Doxygen will then use the output that the filter program writes
800# to standard output. If FILTER_PATTERNS is specified, this tag will be
801# ignored.
802
803INPUT_FILTER =
804
805# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
806# basis. Doxygen will compare the file name with each pattern and apply the
807# filter if there is a match. The filters are a list of the form:
808# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
809# info on how filters are used. If FILTER_PATTERNS is empty or if
810# non of the patterns match the file name, INPUT_FILTER is applied.
811
812FILTER_PATTERNS =
813
814# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
815# INPUT_FILTER) will be used to filter the input files when producing source
816# files to browse (i.e. when SOURCE_BROWSER is set to YES).
817
818FILTER_SOURCE_FILES = NO
819
820# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
821# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
822# and it is also possible to disable source filtering for a specific pattern
823# using *.ext= (so without naming a filter). This option only has effect when
824# FILTER_SOURCE_FILES is enabled.
825
826FILTER_SOURCE_PATTERNS =
827
828# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that
829# is part of the input, its contents will be placed on the main page (index.html).
830# This can be useful if you have a project on for instance GitHub and want reuse
831# the introduction page also for the doxygen output.
832
833USE_MDFILE_AS_MAINPAGE =
834
835#---------------------------------------------------------------------------
836# configuration options related to source browsing
837#---------------------------------------------------------------------------
838
839# If the SOURCE_BROWSER tag is set to YES then a list of source files will
840# be generated. Documented entities will be cross-referenced with these sources.
841# Note: To get rid of all source code in the generated output, make sure also
842# VERBATIM_HEADERS is set to NO.
843
844SOURCE_BROWSER = NO
845
846# Setting the INLINE_SOURCES tag to YES will include the body
847# of functions and classes directly in the documentation.
848
849INLINE_SOURCES = NO
850
851# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
852# doxygen to hide any special comment blocks from generated source code
853# fragments. Normal C, C++ and Fortran comments will always remain visible.
854
855STRIP_CODE_COMMENTS = NO
856
857# If the REFERENCED_BY_RELATION tag is set to YES
858# then for each documented function all documented
859# functions referencing it will be listed.
860
861REFERENCED_BY_RELATION = NO
862
863# If the REFERENCES_RELATION tag is set to YES
864# then for each documented function all documented entities
865# called/used by that function will be listed.
866
867REFERENCES_RELATION = NO
868
869# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
870# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
871# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
872# link to the source code. Otherwise they will link to the documentation.
873
874REFERENCES_LINK_SOURCE = YES
875
876# If the USE_HTAGS tag is set to YES then the references to source code
877# will point to the HTML generated by the htags(1) tool instead of doxygen
878# built-in source browser. The htags tool is part of GNU's global source
879# tagging system (see http://www.gnu.org/software/global/global.html). You
880# will need version 4.8.6 or higher.
881
882USE_HTAGS = NO
883
884# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
885# will generate a verbatim copy of the header file for each class for
886# which an include is specified. Set to NO to disable this.
887
888VERBATIM_HEADERS = NO
889
890#---------------------------------------------------------------------------
891# configuration options related to the alphabetical class index
892#---------------------------------------------------------------------------
893
894# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
895# of all compounds will be generated. Enable this if the project
896# contains a lot of classes, structs, unions or interfaces.
897
898ALPHABETICAL_INDEX = NO
899
900# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
901# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
902# in which this list will be split (can be a number in the range [1..20])
903
904COLS_IN_ALPHA_INDEX = 5
905
906# In case all classes in a project start with a common prefix, all
907# classes will be put under the same header in the alphabetical index.
908# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
909# should be ignored while generating the index headers.
910
911IGNORE_PREFIX =
912
913#---------------------------------------------------------------------------
914# configuration options related to the HTML output
915#---------------------------------------------------------------------------
916
917# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
918# generate HTML output.
919
920GENERATE_HTML = YES
921
922# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
923# If a relative path is entered the value of OUTPUT_DIRECTORY will be
924# put in front of it. If left blank `html' will be used as the default path.
925
926HTML_OUTPUT = $(HTML_OUTPUT)
927
928# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
929# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
930# doxygen will generate files with .html extension.
931
932HTML_FILE_EXTENSION = .html
933
934# The HTML_HEADER tag can be used to specify a personal HTML header for
935# each generated HTML page. If it is left blank doxygen will generate a
936# standard header. Note that when using a custom header you are responsible
937# for the proper inclusion of any scripts and style sheets that doxygen
938# needs, which is dependent on the configuration options used.
939# It is advised to generate a default header using "doxygen -w html
940# header.html footer.html stylesheet.css YourConfigFile" and then modify
941# that header. Note that the header is subject to change so you typically
942# have to redo this when upgrading to a newer version of doxygen or when
943# changing the value of configuration settings such as GENERATE_TREEVIEW!
944
945HTML_HEADER = $(HTML_HEADER)
946
947# The HTML_FOOTER tag can be used to specify a personal HTML footer for
948# each generated HTML page. If it is left blank doxygen will generate a
949# standard footer.
950
951HTML_FOOTER = $(HTML_FOOTER)
952
953# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
954# style sheet that is used by each HTML page. It can be used to
955# fine-tune the look of the HTML output. If left blank doxygen will
956# generate a default style sheet. Note that it is recommended to use
957# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
958# tag will in the future become obsolete.
959
960HTML_STYLESHEET =
961
962# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
963# user-defined cascading style sheet that is included after the standard
964# style sheets created by doxygen. Using this option one can overrule
965# certain style aspects. This is preferred over using HTML_STYLESHEET
966# since it does not replace the standard style sheet and is therefor more
967# robust against future updates. Doxygen will copy the style sheet file to
968# the output directory.
969
970HTML_EXTRA_STYLESHEET =
971
972# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
973# other source files which should be copied to the HTML output directory. Note
974# that these files will be copied to the base HTML output directory. Use the
975# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
976# files. In the HTML_STYLESHEET file, use the file name only. Also note that
977# the files will be copied as-is; there are no commands or markers available.
978
979HTML_EXTRA_FILES =
980
981# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
982# Doxygen will adjust the colors in the style sheet and background images
983# according to this color. Hue is specified as an angle on a colorwheel,
984# see http://en.wikipedia.org/wiki/Hue for more information.
985# For instance the value 0 represents red, 60 is yellow, 120 is green,
986# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
987# The allowed range is 0 to 359.
988
989HTML_COLORSTYLE_HUE = 220
990
991# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
992# the colors in the HTML output. For a value of 0 the output will use
993# grayscales only. A value of 255 will produce the most vivid colors.
994
995HTML_COLORSTYLE_SAT = 0
996
997# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
998# the luminance component of the colors in the HTML output. Values below
999# 100 gradually make the output lighter, whereas values above 100 make
1000# the output darker. The value divided by 100 is the actual gamma applied,
1001# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
1002# and 100 does not change the gamma.
1003
1004HTML_COLORSTYLE_GAMMA = 80
1005
1006# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1007# page will contain the date and time when the page was generated. Setting
1008# this to NO can help when comparing the output of multiple runs.
1009
1010HTML_TIMESTAMP = YES
1011
1012# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1013# documentation will contain sections that can be hidden and shown after the
1014# page has loaded.
1015
1016HTML_DYNAMIC_SECTIONS = NO
1017
1018# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
1019# entries shown in the various tree structured indices initially; the user
1020# can expand and collapse entries dynamically later on. Doxygen will expand
1021# the tree to such a level that at most the specified number of entries are
1022# visible (unless a fully collapsed tree already exceeds this amount).
1023# So setting the number of entries 1 will produce a full collapsed tree by
1024# default. 0 is a special value representing an infinite number of entries
1025# and will result in a full expanded tree by default.
1026
1027HTML_INDEX_NUM_ENTRIES = 100
1028
1029# If the GENERATE_DOCSET tag is set to YES, additional index files
1030# will be generated that can be used as input for Apple's Xcode 3
1031# integrated development environment, introduced with OSX 10.5 (Leopard).
1032# To create a documentation set, doxygen will generate a Makefile in the
1033# HTML output directory. Running make will produce the docset in that
1034# directory and running "make install" will install the docset in
1035# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
1036# it at startup.
1037# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1038# for more information.
1039
1040GENERATE_DOCSET = NO
1041
1042# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
1043# feed. A documentation feed provides an umbrella under which multiple
1044# documentation sets from a single provider (such as a company or product suite)
1045# can be grouped.
1046
1047DOCSET_FEEDNAME = "Doxygen generated docs"
1048
1049# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
1050# should uniquely identify the documentation set bundle. This should be a
1051# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1052# will append .docset to the name.
1053
1054DOCSET_BUNDLE_ID = org.doxygen.Project
1055
1056# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
1057# identify the documentation publisher. This should be a reverse domain-name
1058# style string, e.g. com.mycompany.MyDocSet.documentation.
1059
1060DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1061
1062# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1063
1064DOCSET_PUBLISHER_NAME = Publisher
1065
1066# If the GENERATE_HTMLHELP tag is set to YES, additional index files
1067# will be generated that can be used as input for tools like the
1068# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1069# of the generated HTML documentation.
1070
1071GENERATE_HTMLHELP = NO
1072
1073# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1074# be used to specify the file name of the resulting .chm file. You
1075# can add a path in front of the file if the result should not be
1076# written to the html output directory.
1077
1078CHM_FILE =
1079
1080# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1081# be used to specify the location (absolute path including file name) of
1082# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1083# the HTML help compiler on the generated index.hhp.
1084
1085HHC_LOCATION =
1086
1087# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1088# controls if a separate .chi index file is generated (YES) or that
1089# it should be included in the master .chm file (NO).
1090
1091GENERATE_CHI = NO
1092
1093# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1094# is used to encode HtmlHelp index (hhk), content (hhc) and project file
1095# content.
1096
1097CHM_INDEX_ENCODING =
1098
1099# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1100# controls whether a binary table of contents is generated (YES) or a
1101# normal table of contents (NO) in the .chm file.
1102
1103BINARY_TOC = NO
1104
1105# The TOC_EXPAND flag can be set to YES to add extra items for group members
1106# to the contents of the HTML help documentation and to the tree view.
1107
1108TOC_EXPAND = NO
1109
1110# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1111# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1112# that can be used as input for Qt's qhelpgenerator to generate a
1113# Qt Compressed Help (.qch) of the generated HTML documentation.
1114
1115GENERATE_QHP = NO
1116
1117# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1118# be used to specify the file name of the resulting .qch file.
1119# The path specified is relative to the HTML output folder.
1120
1121QCH_FILE =
1122
1123# The QHP_NAMESPACE tag specifies the namespace to use when generating
1124# Qt Help Project output. For more information please see
1125# http://doc.trolltech.com/qthelpproject.html#namespace
1126
1127QHP_NAMESPACE = org.doxygen.Project
1128
1129# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1130# Qt Help Project output. For more information please see
1131# http://doc.trolltech.com/qthelpproject.html#virtual-folders
1132
1133QHP_VIRTUAL_FOLDER = doc
1134
1135# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1136# add. For more information please see
1137# http://doc.trolltech.com/qthelpproject.html#custom-filters
1138
1139QHP_CUST_FILTER_NAME =
1140
1141# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1142# custom filter to add. For more information please see
1143# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1144# Qt Help Project / Custom Filters</a>.
1145
1146QHP_CUST_FILTER_ATTRS =
1147
1148# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1149# project's
1150# filter section matches.
1151# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1152# Qt Help Project / Filter Attributes</a>.
1153
1154QHP_SECT_FILTER_ATTRS =
1155
1156# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1157# be used to specify the location of Qt's qhelpgenerator.
1158# If non-empty doxygen will try to run qhelpgenerator on the generated
1159# .qhp file.
1160
1161QHG_LOCATION =
1162
1163# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1164# will be generated, which together with the HTML files, form an Eclipse help
1165# plugin. To install this plugin and make it available under the help contents
1166# menu in Eclipse, the contents of the directory containing the HTML and XML
1167# files needs to be copied into the plugins directory of eclipse. The name of
1168# the directory within the plugins directory should be the same as
1169# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1170# the help appears.
1171
1172GENERATE_ECLIPSEHELP = NO
1173
1174# A unique identifier for the eclipse help plugin. When installing the plugin
1175# the directory name containing the HTML and XML files should also have
1176# this name.
1177
1178ECLIPSE_DOC_ID = org.doxygen.Project
1179
1180# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1181# at top of each HTML page. The value NO (the default) enables the index and
1182# the value YES disables it. Since the tabs have the same information as the
1183# navigation tree you can set this option to NO if you already set
1184# GENERATE_TREEVIEW to YES.
1185
1186DISABLE_INDEX = YES
1187
1188# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1189# structure should be generated to display hierarchical information.
1190# If the tag value is set to YES, a side panel will be generated
1191# containing a tree-like index structure (just like the one that
1192# is generated for HTML Help). For this to work a browser that supports
1193# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1194# Windows users are probably better off using the HTML help feature.
1195# Since the tree basically has the same information as the tab index you
1196# could consider to set DISABLE_INDEX to NO when enabling this option.
1197
1198GENERATE_TREEVIEW = NO
1199
1200# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1201# (range [0,1..20]) that doxygen will group on one line in the generated HTML
1202# documentation. Note that a value of 0 will completely suppress the enum
1203# values from appearing in the overview section.
1204
1205ENUM_VALUES_PER_LINE = 4
1206
1207# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1208# used to set the initial width (in pixels) of the frame in which the tree
1209# is shown.
1210
1211TREEVIEW_WIDTH = 250
1212
1213# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1214# links to external symbols imported via tag files in a separate window.
1215
1216EXT_LINKS_IN_WINDOW = NO
1217
1218# Use this tag to change the font size of Latex formulas included
1219# as images in the HTML documentation. The default is 10. Note that
1220# when you change the font size after a successful doxygen run you need
1221# to manually remove any form_*.png images from the HTML output directory
1222# to force them to be regenerated.
1223
1224FORMULA_FONTSIZE = 10
1225
1226# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1227# generated for formulas are transparent PNGs. Transparent PNGs are
1228# not supported properly for IE 6.0, but are supported on all modern browsers.
1229# Note that when changing this option you need to delete any form_*.png files
1230# in the HTML output before the changes have effect.
1231
1232FORMULA_TRANSPARENT = YES
1233
1234# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1235# (see http://www.mathjax.org) which uses client side Javascript for the
1236# rendering instead of using prerendered bitmaps. Use this if you do not
1237# have LaTeX installed or if you want to formulas look prettier in the HTML
1238# output. When enabled you may also need to install MathJax separately and
1239# configure the path to it using the MATHJAX_RELPATH option.
1240
1241USE_MATHJAX = NO
1242
1243# When MathJax is enabled you can set the default output format to be used for
1244# thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and
1245# SVG. The default value is HTML-CSS, which is slower, but has the best
1246# compatibility.
1247
1248MATHJAX_FORMAT = HTML-CSS
1249
1250# When MathJax is enabled you need to specify the location relative to the
1251# HTML output directory using the MATHJAX_RELPATH option. The destination
1252# directory should contain the MathJax.js script. For instance, if the mathjax
1253# directory is located at the same level as the HTML output directory, then
1254# MATHJAX_RELPATH should be ../mathjax. The default value points to
1255# the MathJax Content Delivery Network so you can quickly see the result without
1256# installing MathJax. However, it is strongly recommended to install a local
1257# copy of MathJax from http://www.mathjax.org before deployment.
1258
1259MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1260
1261# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1262# names that should be enabled during MathJax rendering.
1263
1264MATHJAX_EXTENSIONS =
1265
1266# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1267# for the HTML output. The underlying search engine uses javascript
1268# and DHTML and should work on any modern browser. Note that when using
1269# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1270# (GENERATE_DOCSET) there is already a search function so this one should
1271# typically be disabled. For large projects the javascript based search engine
1272# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1273
1274SEARCHENGINE = NO
1275
1276# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1277# implemented using a web server instead of a web client using Javascript.
1278# There are two flavours of web server based search depending on the
1279# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1280# searching and an index file used by the script. When EXTERNAL_SEARCH is
1281# enabled the indexing and searching needs to be provided by external tools.
1282# See the manual for details.
1283
1284SERVER_BASED_SEARCH = NO
1285
1286# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP
1287# script for searching. Instead the search results are written to an XML file
1288# which needs to be processed by an external indexer. Doxygen will invoke an
1289# external search engine pointed to by the SEARCHENGINE_URL option to obtain
1290# the search results. Doxygen ships with an example indexer (doxyindexer) and
1291# search engine (doxysearch.cgi) which are based on the open source search engine
1292# library Xapian. See the manual for configuration details.
1293
1294EXTERNAL_SEARCH = NO
1295
1296# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1297# which will returned the search results when EXTERNAL_SEARCH is enabled.
1298# Doxygen ships with an example search engine (doxysearch) which is based on
1299# the open source search engine library Xapian. See the manual for configuration
1300# details.
1301
1302SEARCHENGINE_URL =
1303
1304# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1305# search data is written to a file for indexing by an external tool. With the
1306# SEARCHDATA_FILE tag the name of this file can be specified.
1307
1308SEARCHDATA_FILE = searchdata.xml
1309
1310# When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the
1311# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1312# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1313# projects and redirect the results back to the right project.
1314
1315EXTERNAL_SEARCH_ID =
1316
1317# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1318# projects other than the one defined by this configuration file, but that are
1319# all added to the same external search index. Each project needs to have a
1320# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id
1321# of to a relative location where the documentation can be found.
1322# The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ...
1323
1324EXTRA_SEARCH_MAPPINGS =
1325
1326#---------------------------------------------------------------------------
1327# configuration options related to the LaTeX output
1328#---------------------------------------------------------------------------
1329
1330# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1331# generate Latex output.
1332
1333GENERATE_LATEX = NO
1334
1335# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1336# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1337# put in front of it. If left blank `latex' will be used as the default path.
1338
1339LATEX_OUTPUT = latex
1340
1341# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1342# invoked. If left blank `latex' will be used as the default command name.
1343# Note that when enabling USE_PDFLATEX this option is only used for
1344# generating bitmaps for formulas in the HTML output, but not in the
1345# Makefile that is written to the output directory.
1346
1347LATEX_CMD_NAME = latex
1348
1349# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1350# generate index for LaTeX. If left blank `makeindex' will be used as the
1351# default command name.
1352
1353MAKEINDEX_CMD_NAME = makeindex
1354
1355# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1356# LaTeX documents. This may be useful for small projects and may help to
1357# save some trees in general.
1358
1359COMPACT_LATEX = NO
1360
1361# The PAPER_TYPE tag can be used to set the paper type that is used
1362# by the printer. Possible values are: a4, letter, legal and
1363# executive. If left blank a4wide will be used.
1364
1365PAPER_TYPE = a4
1366
1367# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1368# packages that should be included in the LaTeX output.
1369
1370EXTRA_PACKAGES =
1371
1372# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1373# the generated latex document. The header should contain everything until
1374# the first chapter. If it is left blank doxygen will generate a
1375# standard header. Notice: only use this tag if you know what you are doing!
1376
1377LATEX_HEADER =
1378
1379# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1380# the generated latex document. The footer should contain everything after
1381# the last chapter. If it is left blank doxygen will generate a
1382# standard footer. Notice: only use this tag if you know what you are doing!
1383
1384LATEX_FOOTER =
1385
1386# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1387# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1388# contain links (just like the HTML output) instead of page references
1389# This makes the output suitable for online browsing using a pdf viewer.
1390
1391PDF_HYPERLINKS = YES
1392
1393# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1394# plain latex in the generated Makefile. Set this option to YES to get a
1395# higher quality PDF documentation.
1396
1397USE_PDFLATEX = YES
1398
1399# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1400# command to the generated LaTeX files. This will instruct LaTeX to keep
1401# running if errors occur, instead of asking the user for help.
1402# This option is also used when generating formulas in HTML.
1403
1404LATEX_BATCHMODE = NO
1405
1406# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1407# include the index chapters (such as File Index, Compound Index, etc.)
1408# in the output.
1409
1410LATEX_HIDE_INDICES = NO
1411
1412# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1413# source code with syntax highlighting in the LaTeX output.
1414# Note that which sources are shown also depends on other settings
1415# such as SOURCE_BROWSER.
1416
1417LATEX_SOURCE_CODE = NO
1418
1419# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1420# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1421# http://en.wikipedia.org/wiki/BibTeX for more info.
1422
1423LATEX_BIB_STYLE = plain
1424
1425#---------------------------------------------------------------------------
1426# configuration options related to the RTF output
1427#---------------------------------------------------------------------------
1428
1429# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1430# The RTF output is optimized for Word 97 and may not look very pretty with
1431# other RTF readers or editors.
1432
1433GENERATE_RTF = NO
1434
1435# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1436# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1437# put in front of it. If left blank `rtf' will be used as the default path.
1438
1439RTF_OUTPUT = rtf
1440
1441# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1442# RTF documents. This may be useful for small projects and may help to
1443# save some trees in general.
1444
1445COMPACT_RTF = NO
1446
1447# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1448# will contain hyperlink fields. The RTF file will
1449# contain links (just like the HTML output) instead of page references.
1450# This makes the output suitable for online browsing using WORD or other
1451# programs which support those fields.
1452# Note: wordpad (write) and others do not support links.
1453
1454RTF_HYPERLINKS = NO
1455
1456# Load style sheet definitions from file. Syntax is similar to doxygen's
1457# config file, i.e. a series of assignments. You only have to provide
1458# replacements, missing definitions are set to their default value.
1459
1460RTF_STYLESHEET_FILE =
1461
1462# Set optional variables used in the generation of an rtf document.
1463# Syntax is similar to doxygen's config file.
1464
1465RTF_EXTENSIONS_FILE =
1466
1467#---------------------------------------------------------------------------
1468# configuration options related to the man page output
1469#---------------------------------------------------------------------------
1470
1471# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1472# generate man pages
1473
1474GENERATE_MAN = NO
1475
1476# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1477# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1478# put in front of it. If left blank `man' will be used as the default path.
1479
1480MAN_OUTPUT = man
1481
1482# The MAN_EXTENSION tag determines the extension that is added to
1483# the generated man pages (default is the subroutine's section .3)
1484
1485MAN_EXTENSION = .3
1486
1487# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1488# then it will generate one additional man file for each entity
1489# documented in the real man page(s). These additional files
1490# only source the real man page, but without them the man command
1491# would be unable to find the correct page. The default is NO.
1492
1493MAN_LINKS = NO
1494
1495#---------------------------------------------------------------------------
1496# configuration options related to the XML output
1497#---------------------------------------------------------------------------
1498
1499# If the GENERATE_XML tag is set to YES Doxygen will
1500# generate an XML file that captures the structure of
1501# the code including all documentation.
1502
1503GENERATE_XML = NO
1504
1505# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1506# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1507# put in front of it. If left blank `xml' will be used as the default path.
1508
1509XML_OUTPUT = xml
1510
1511# The XML_SCHEMA tag can be used to specify an XML schema,
1512# which can be used by a validating XML parser to check the
1513# syntax of the XML files.
1514
1515XML_SCHEMA =
1516
1517# The XML_DTD tag can be used to specify an XML DTD,
1518# which can be used by a validating XML parser to check the
1519# syntax of the XML files.
1520
1521XML_DTD =
1522
1523# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1524# dump the program listings (including syntax highlighting
1525# and cross-referencing information) to the XML output. Note that
1526# enabling this will significantly increase the size of the XML output.
1527
1528XML_PROGRAMLISTING = YES
1529
1530#---------------------------------------------------------------------------
1531# configuration options for the AutoGen Definitions output
1532#---------------------------------------------------------------------------
1533
1534# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1535# generate an AutoGen Definitions (see autogen.sf.net) file
1536# that captures the structure of the code including all
1537# documentation. Note that this feature is still experimental
1538# and incomplete at the moment.
1539
1540GENERATE_AUTOGEN_DEF = NO
1541
1542#---------------------------------------------------------------------------
1543# configuration options related to the Perl module output
1544#---------------------------------------------------------------------------
1545
1546# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1547# generate a Perl module file that captures the structure of
1548# the code including all documentation. Note that this
1549# feature is still experimental and incomplete at the
1550# moment.
1551
1552GENERATE_PERLMOD = NO
1553
1554# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1555# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1556# to generate PDF and DVI output from the Perl module output.
1557
1558PERLMOD_LATEX = NO
1559
1560# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1561# nicely formatted so it can be parsed by a human reader. This is useful
1562# if you want to understand what is going on. On the other hand, if this
1563# tag is set to NO the size of the Perl module output will be much smaller
1564# and Perl will parse it just the same.
1565
1566PERLMOD_PRETTY = YES
1567
1568# The names of the make variables in the generated doxyrules.make file
1569# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1570# This is useful so different doxyrules.make files included by the same
1571# Makefile don't overwrite each other's variables.
1572
1573PERLMOD_MAKEVAR_PREFIX =
1574
1575#---------------------------------------------------------------------------
1576# Configuration options related to the preprocessor
1577#---------------------------------------------------------------------------
1578
1579# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1580# evaluate all C-preprocessor directives found in the sources and include
1581# files.
1582
1583ENABLE_PREPROCESSING = YES
1584
1585# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1586# names in the source code. If set to NO (the default) only conditional
1587# compilation will be performed. Macro expansion can be done in a controlled
1588# way by setting EXPAND_ONLY_PREDEF to YES.
1589
1590MACRO_EXPANSION = NO
1591
1592# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1593# then the macro expansion is limited to the macros specified with the
1594# PREDEFINED and EXPAND_AS_DEFINED tags.
1595
1596EXPAND_ONLY_PREDEF = NO
1597
1598# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1599# pointed to by INCLUDE_PATH will be searched when a #include is found.
1600
1601SEARCH_INCLUDES = YES
1602
1603# The INCLUDE_PATH tag can be used to specify one or more directories that
1604# contain include files that are not input files but should be processed by
1605# the preprocessor.
1606
1607INCLUDE_PATH =
1608
1609# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1610# patterns (like *.h and *.hpp) to filter out the header-files in the
1611# directories. If left blank, the patterns specified with FILE_PATTERNS will
1612# be used.
1613
1614INCLUDE_FILE_PATTERNS =
1615
1616# The PREDEFINED tag can be used to specify one or more macro names that
1617# are defined before the preprocessor is started (similar to the -D option of
1618# gcc). The argument of the tag is a list of macros of the form: name
1619# or name=definition (no spaces). If the definition and the = are
1620# omitted =1 is assumed. To prevent a macro definition from being
1621# undefined via #undef or recursively expanded use the := operator
1622# instead of the = operator.
1623
1624PREDEFINED =
1625
1626# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1627# this tag can be used to specify a list of macro names that should be expanded.
1628# The macro definition that is found in the sources will be used.
1629# Use the PREDEFINED tag if you want to use a different macro definition that
1630# overrules the definition found in the source code.
1631
1632EXPAND_AS_DEFINED =
1633
1634# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1635# doxygen's preprocessor will remove all references to function-like macros
1636# that are alone on a line, have an all uppercase name, and do not end with a
1637# semicolon, because these will confuse the parser if not removed.
1638
1639SKIP_FUNCTION_MACROS = YES
1640
1641#---------------------------------------------------------------------------
1642# Configuration::additions related to external references
1643#---------------------------------------------------------------------------
1644
1645# The TAGFILES option can be used to specify one or more tagfiles. For each
1646# tag file the location of the external documentation should be added. The
1647# format of a tag file without this location is as follows:
1648# TAGFILES = file1 file2 ...
1649# Adding location for the tag files is done as follows:
1650# TAGFILES = file1=loc1 "file2 = loc2" ...
1651# where "loc1" and "loc2" can be relative or absolute paths
1652# or URLs. Note that each tag file must have a unique name (where the name does
1653# NOT include the path). If a tag file is not located in the directory in which
1654# doxygen is run, you must also specify the path to the tagfile here.
1655
1656TAGFILES =
1657
1658# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1659# a tag file that is based on the input files it reads.
1660
1661GENERATE_TAGFILE =
1662
1663# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1664# in the class index. If set to NO only the inherited external classes
1665# will be listed.
1666
1667ALLEXTERNALS = NO
1668
1669# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1670# in the modules index. If set to NO, only the current project's groups will
1671# be listed.
1672
1673EXTERNAL_GROUPS = YES
1674
1675# The PERL_PATH should be the absolute path and name of the perl script
1676# interpreter (i.e. the result of `which perl').
1677
1678PERL_PATH = /usr/bin/perl
1679
1680#---------------------------------------------------------------------------
1681# Configuration options related to the dot tool
1682#---------------------------------------------------------------------------
1683
1684# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1685# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1686# or super classes. Setting the tag to NO turns the diagrams off. Note that
1687# this option also works with HAVE_DOT disabled, but it is recommended to
1688# install and use dot, since it yields more powerful graphs.
1689
1690CLASS_DIAGRAMS = NO
1691
1692# You can define message sequence charts within doxygen comments using the \msc
1693# command. Doxygen will then run the mscgen tool (see
1694# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1695# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1696# the mscgen tool resides. If left empty the tool is assumed to be found in the
1697# default search path.
1698
1699MSCGEN_PATH =
1700
1701# If set to YES, the inheritance and collaboration graphs will hide
1702# inheritance and usage relations if the target is undocumented
1703# or is not a class.
1704
1705HIDE_UNDOC_RELATIONS = YES
1706
1707# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1708# available from the path. This tool is part of Graphviz, a graph visualization
1709# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1710# have no effect if this option is set to NO (the default)
1711
1712HAVE_DOT = NO
1713
1714# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1715# allowed to run in parallel. When set to 0 (the default) doxygen will
1716# base this on the number of processors available in the system. You can set it
1717# explicitly to a value larger than 0 to get control over the balance
1718# between CPU load and processing speed.
1719
1720DOT_NUM_THREADS = 0
1721
1722# By default doxygen will use the Helvetica font for all dot files that
1723# doxygen generates. When you want a differently looking font you can specify
1724# the font name using DOT_FONTNAME. You need to make sure dot is able to find
1725# the font, which can be done by putting it in a standard location or by setting
1726# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1727# directory containing the font.
1728
1729DOT_FONTNAME = Helvetica
1730
1731# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1732# The default size is 10pt.
1733
1734DOT_FONTSIZE = 10
1735
1736# By default doxygen will tell dot to use the Helvetica font.
1737# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1738# set the path where dot can find it.
1739
1740DOT_FONTPATH =
1741
1742# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1743# will generate a graph for each documented class showing the direct and
1744# indirect inheritance relations. Setting this tag to YES will force the
1745# CLASS_DIAGRAMS tag to NO.
1746
1747CLASS_GRAPH = YES
1748
1749# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1750# will generate a graph for each documented class showing the direct and
1751# indirect implementation dependencies (inheritance, containment, and
1752# class references variables) of the class with other documented classes.
1753
1754COLLABORATION_GRAPH = YES
1755
1756# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1757# will generate a graph for groups, showing the direct groups dependencies
1758
1759GROUP_GRAPHS = YES
1760
1761# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1762# collaboration diagrams in a style similar to the OMG's Unified Modeling
1763# Language.
1764
1765UML_LOOK = NO
1766
1767# If the UML_LOOK tag is enabled, the fields and methods are shown inside
1768# the class node. If there are many fields or methods and many nodes the
1769# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
1770# threshold limits the number of items for each type to make the size more
1771# managable. Set this to 0 for no limit. Note that the threshold may be
1772# exceeded by 50% before the limit is enforced.
1773
1774UML_LIMIT_NUM_FIELDS = 10
1775
1776# If set to YES, the inheritance and collaboration graphs will show the
1777# relations between templates and their instances.
1778
1779TEMPLATE_RELATIONS = NO
1780
1781# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1782# tags are set to YES then doxygen will generate a graph for each documented
1783# file showing the direct and indirect include dependencies of the file with
1784# other documented files.
1785
1786INCLUDE_GRAPH = YES
1787
1788# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1789# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1790# documented header file showing the documented files that directly or
1791# indirectly include this file.
1792
1793INCLUDED_BY_GRAPH = YES
1794
1795# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1796# doxygen will generate a call dependency graph for every global function
1797# or class method. Note that enabling this option will significantly increase
1798# the time of a run. So in most cases it will be better to enable call graphs
1799# for selected functions only using the \callgraph command.
1800
1801CALL_GRAPH = NO
1802
1803# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1804# doxygen will generate a caller dependency graph for every global function
1805# or class method. Note that enabling this option will significantly increase
1806# the time of a run. So in most cases it will be better to enable caller
1807# graphs for selected functions only using the \callergraph command.
1808
1809CALLER_GRAPH = NO
1810
1811# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1812# will generate a graphical hierarchy of all classes instead of a textual one.
1813
1814GRAPHICAL_HIERARCHY = YES
1815
1816# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
1817# then doxygen will show the dependencies a directory has on other directories
1818# in a graphical way. The dependency relations are determined by the #include
1819# relations between the files in the directories.
1820
1821DIRECTORY_GRAPH = YES
1822
1823# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1824# generated by dot. Possible values are svg, png, jpg, or gif.
1825# If left blank png will be used. If you choose svg you need to set
1826# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1827# visible in IE 9+ (other browsers do not have this requirement).
1828
1829DOT_IMAGE_FORMAT = png
1830
1831# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1832# enable generation of interactive SVG images that allow zooming and panning.
1833# Note that this requires a modern browser other than Internet Explorer.
1834# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1835# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1836# visible. Older versions of IE do not have SVG support.
1837
1838INTERACTIVE_SVG = NO
1839
1840# The tag DOT_PATH can be used to specify the path where the dot tool can be
1841# found. If left blank, it is assumed the dot tool can be found in the path.
1842
1843DOT_PATH =
1844
1845# The DOTFILE_DIRS tag can be used to specify one or more directories that
1846# contain dot files that are included in the documentation (see the
1847# \dotfile command).
1848
1849DOTFILE_DIRS =
1850
1851# The MSCFILE_DIRS tag can be used to specify one or more directories that
1852# contain msc files that are included in the documentation (see the
1853# \mscfile command).
1854
1855MSCFILE_DIRS =
1856
1857# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1858# nodes that will be shown in the graph. If the number of nodes in a graph
1859# becomes larger than this value, doxygen will truncate the graph, which is
1860# visualized by representing a node as a red box. Note that doxygen if the
1861# number of direct children of the root node in a graph is already larger than
1862# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1863# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1864
1865DOT_GRAPH_MAX_NODES = 50
1866
1867# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1868# graphs generated by dot. A depth value of 3 means that only nodes reachable
1869# from the root by following a path via at most 3 edges will be shown. Nodes
1870# that lay further from the root node will be omitted. Note that setting this
1871# option to 1 or 2 may greatly reduce the computation time needed for large
1872# code bases. Also note that the size of a graph can be further restricted by
1873# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1874
1875MAX_DOT_GRAPH_DEPTH = 0
1876
1877# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1878# background. This is disabled by default, because dot on Windows does not
1879# seem to support this out of the box. Warning: Depending on the platform used,
1880# enabling this option may lead to badly anti-aliased labels on the edges of
1881# a graph (i.e. they become hard to read).
1882
1883DOT_TRANSPARENT = NO
1884
1885# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1886# files in one run (i.e. multiple -o and -T options on the command line). This
1887# makes dot run faster, but since only newer versions of dot (>1.8.10)
1888# support this, this feature is disabled by default.
1889
1890DOT_MULTI_TARGETS = NO
1891
1892# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1893# generate a legend page explaining the meaning of the various boxes and
1894# arrows in the dot generated graphs.
1895
1896GENERATE_LEGEND = YES
1897
1898# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1899# remove the intermediate dot files that are used to generate
1900# the various graphs.
1901
1902DOT_CLEANUP = YES
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 000000000..5104d81c2
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,13 @@
1HEADERS := $(wildcard ../include/android/*.h)
2
3all: html jd
4
5html: $(HEADERS) Doxyfile
6 mkdir -p html
7 doxygen
8
9jd: $(HEADERS) Doxyfile header.jd
10 mkdir -p jd
11 HTML_HEADER=header.jd HTML_FOOTER=footer.jd HTML_OUTPUT=jd doxygen
12 for file in jd/*.html; do mv "$${file}" "$${file/.html/.jd}"; done
13 rm -f jd/index.jd
diff --git a/docs/footer.jd b/docs/footer.jd
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/docs/footer.jd
diff --git a/docs/header.jd b/docs/header.jd
new file mode 100644
index 000000000..e50f41b03
--- /dev/null
+++ b/docs/header.jd
@@ -0,0 +1,3 @@
1page.title=$title
2page.customHeadTag=<link rel="stylesheet" type="text/css" href="doxygen-dac.css">
3@jd:body
diff --git a/include/android/asset_manager.h b/include/android/asset_manager.h
index f5df46bd7..d65483968 100644
--- a/include/android/asset_manager.h
+++ b/include/android/asset_manager.h
@@ -14,6 +14,14 @@
14 * limitations under the License. 14 * limitations under the License.
15 */ 15 */
16 16
17/**
18 * @addtogroup Asset
19 * @{
20 */
21
22/**
23 * @file asset_manager.h
24 */
17 25
18#ifndef ANDROID_ASSET_MANAGER_H 26#ifndef ANDROID_ASSET_MANAGER_H
19#define ANDROID_ASSET_MANAGER_H 27#define ANDROID_ASSET_MANAGER_H
@@ -23,19 +31,49 @@ extern "C" {
23#endif 31#endif
24 32
25struct AAssetManager; 33struct AAssetManager;
34/**
35 * {@link AAssetManager} provides access to an application's raw assets by
36 * creating {@link AAsset} objects.
37 *
38 * AAssetManager is a wrapper to the low-level native implementation
39 * of the java {@link AAssetManager}, a pointer can be obtained using
40 * AAssetManager_fromJava().
41 *
42 * The asset hierarchy may be examined like a filesystem, using
43 * {@link AAssetDir} objects to peruse a single directory.
44 *
45 * A native {@link AAssetManager} pointer may be shared across multiple threads.
46 */
26typedef struct AAssetManager AAssetManager; 47typedef struct AAssetManager AAssetManager;
27 48
28struct AAssetDir; 49struct AAssetDir;
50/**
51 * {@link AAssetDir} provides access to a chunk of the asset hierarchy as if
52 * it were a single directory. The contents are populated by the
53 * {@link AAssetManager}.
54 *
55 * The list of files will be sorted in ascending order by ASCII value.
56 */
29typedef struct AAssetDir AAssetDir; 57typedef struct AAssetDir AAssetDir;
30 58
31struct AAsset; 59struct AAsset;
60/**
61 * {@link AAsset} provides access to a read-only asset.
62 *
63 * {@link AAsset} objects are NOT thread-safe, and should not be shared across
64 * threads.
65 */
32typedef struct AAsset AAsset; 66typedef struct AAsset AAsset;
33 67
34/* Available modes for opening assets */ 68/** Available access modes for opening assets with {@link AAssetManager_open} */
35enum { 69enum {
70 /** No specific information about how data will be accessed. **/
36 AASSET_MODE_UNKNOWN = 0, 71 AASSET_MODE_UNKNOWN = 0,
72 /** Read chunks, and seek forward and backward. */
37 AASSET_MODE_RANDOM = 1, 73 AASSET_MODE_RANDOM = 1,
74 /** Read sequentially, with an occasional forward seek. */
38 AASSET_MODE_STREAMING = 2, 75 AASSET_MODE_STREAMING = 2,
76 /** Caller plans to ask for a read-only buffer with all data. */
39 AASSET_MODE_BUFFER = 3 77 AASSET_MODE_BUFFER = 3
40}; 78};
41 79
@@ -173,3 +211,5 @@ int AAsset_isAllocated(AAsset* asset);
173#endif 211#endif
174 212
175#endif // ANDROID_ASSET_MANAGER_H 213#endif // ANDROID_ASSET_MANAGER_H
214
215/** @} */
diff --git a/include/android/asset_manager_jni.h b/include/android/asset_manager_jni.h
index aec2d3c97..dcee17e10 100644
--- a/include/android/asset_manager_jni.h
+++ b/include/android/asset_manager_jni.h
@@ -14,6 +14,14 @@
14 * limitations under the License. 14 * limitations under the License.
15 */ 15 */
16 16
17/**
18 * @addtogroup Asset
19 * @{
20 */
21
22/**
23 * @file asset_manager_jni.h
24 */
17 25
18#ifndef ANDROID_ASSET_MANAGER_JNI_H 26#ifndef ANDROID_ASSET_MANAGER_JNI_H
19#define ANDROID_ASSET_MANAGER_JNI_H 27#define ANDROID_ASSET_MANAGER_JNI_H
@@ -38,3 +46,5 @@ AAssetManager* AAssetManager_fromJava(JNIEnv* env, jobject assetManager);
38#endif 46#endif
39 47
40#endif // ANDROID_ASSET_MANAGER_JNI_H 48#endif // ANDROID_ASSET_MANAGER_JNI_H
49
50/** @} */
diff --git a/include/android/bitmap.h b/include/android/bitmap.h
index 6e18763bf..261e64fac 100644
--- a/include/android/bitmap.h
+++ b/include/android/bitmap.h
@@ -14,6 +14,15 @@
14 * limitations under the License. 14 * limitations under the License.
15 */ 15 */
16 16
17/**
18 * @addtogroup Bitmap
19 * @{
20 */
21
22/**
23 * @file bitmap.h
24 */
25
17#ifndef ANDROID_BITMAP_H 26#ifndef ANDROID_BITMAP_H
18#define ANDROID_BITMAP_H 27#define ANDROID_BITMAP_H
19 28
@@ -24,33 +33,52 @@
24extern "C" { 33extern "C" {
25#endif 34#endif
26 35
27#define ANDROID_BITMAP_RESULT_SUCCESS 0 36/** AndroidBitmap functions result code. */
28#define ANDROID_BITMAP_RESULT_BAD_PARAMETER -1 37enum {
29#define ANDROID_BITMAP_RESULT_JNI_EXCEPTION -2 38 /** Operation was successful. */
30#define ANDROID_BITMAP_RESULT_ALLOCATION_FAILED -3 39 ANDROID_BITMAP_RESULT_SUCCESS = 0,
40 /** Bad parameter. */
41 ANDROID_BITMAP_RESULT_BAD_PARAMETER = -1,
42 /** JNI exception occured. */
43 ANDROID_BITMAP_RESULT_JNI_EXCEPTION = -2,
44 /** Allocation failed. */
45 ANDROID_BITMAP_RESULT_ALLOCATION_FAILED = -3,
46};
31 47
32/* Backward compatibility: this macro used to be misspelled. */ 48/** Backward compatibility: this macro used to be misspelled. */
33#define ANDROID_BITMAP_RESUT_SUCCESS ANDROID_BITMAP_RESULT_SUCCESS 49#define ANDROID_BITMAP_RESUT_SUCCESS ANDROID_BITMAP_RESULT_SUCCESS
34 50
51/** Bitmap pixel format. */
35enum AndroidBitmapFormat { 52enum AndroidBitmapFormat {
53 /** No format. */
36 ANDROID_BITMAP_FORMAT_NONE = 0, 54 ANDROID_BITMAP_FORMAT_NONE = 0,
55 /** Red: 8 bits, Green: 8 bits, Blue: 8 bits, Alpha: 8 bits. **/
37 ANDROID_BITMAP_FORMAT_RGBA_8888 = 1, 56 ANDROID_BITMAP_FORMAT_RGBA_8888 = 1,
57 /** Red: 5 bits, Green: 6 bits, Blue: 5 bits. **/
38 ANDROID_BITMAP_FORMAT_RGB_565 = 4, 58 ANDROID_BITMAP_FORMAT_RGB_565 = 4,
59 /** Red: 4 bits, Green: 4 bits, Blue: 4 bits, Alpha: 4 bits. **/
39 ANDROID_BITMAP_FORMAT_RGBA_4444 = 7, 60 ANDROID_BITMAP_FORMAT_RGBA_4444 = 7,
61 /** Deprecated. */
40 ANDROID_BITMAP_FORMAT_A_8 = 8, 62 ANDROID_BITMAP_FORMAT_A_8 = 8,
41}; 63};
42 64
65/** Bitmap info, see AndroidBitmap_getInfo(). */
43typedef struct { 66typedef struct {
67 /** The bitmap width in pixels. */
44 uint32_t width; 68 uint32_t width;
69 /** The bitmap height in pixels. */
45 uint32_t height; 70 uint32_t height;
71 /** The number of byte per row. */
46 uint32_t stride; 72 uint32_t stride;
73 /** The bitmap pixel format. See {@link AndroidBitmapFormat} */
47 int32_t format; 74 int32_t format;
75 /** Unused. */
48 uint32_t flags; // 0 for now 76 uint32_t flags; // 0 for now
49} AndroidBitmapInfo; 77} AndroidBitmapInfo;
50 78
51/** 79/**
52 * Given a java bitmap object, fill out the AndroidBitmap struct for it. 80 * Given a java bitmap object, fill out the AndroidBitmapInfo struct for it.
53 * If the call fails, the info parameter will be ignored 81 * If the call fails, the info parameter will be ignored.
54 */ 82 */
55int AndroidBitmap_getInfo(JNIEnv* env, jobject jbitmap, 83int AndroidBitmap_getInfo(JNIEnv* env, jobject jbitmap,
56 AndroidBitmapInfo* info); 84 AndroidBitmapInfo* info);
@@ -71,7 +99,7 @@ int AndroidBitmap_getInfo(JNIEnv* env, jobject jbitmap,
71int AndroidBitmap_lockPixels(JNIEnv* env, jobject jbitmap, void** addrPtr); 99int AndroidBitmap_lockPixels(JNIEnv* env, jobject jbitmap, void** addrPtr);
72 100
73/** 101/**
74 * Call this to balanace a successful call to AndroidBitmap_lockPixels 102 * Call this to balance a successful call to AndroidBitmap_lockPixels.
75 */ 103 */
76int AndroidBitmap_unlockPixels(JNIEnv* env, jobject jbitmap); 104int AndroidBitmap_unlockPixels(JNIEnv* env, jobject jbitmap);
77 105
@@ -80,3 +108,5 @@ int AndroidBitmap_unlockPixels(JNIEnv* env, jobject jbitmap);
80#endif 108#endif
81 109
82#endif 110#endif
111
112/** @} */
diff --git a/include/android/configuration.h b/include/android/configuration.h
index 7573ccac3..81f71a92c 100644
--- a/include/android/configuration.h
+++ b/include/android/configuration.h
@@ -14,6 +14,15 @@
14 * limitations under the License. 14 * limitations under the License.
15 */ 15 */
16 16
17/**
18 * @addtogroup Configuration
19 * @{
20 */
21
22/**
23 * @file configuration.h
24 */
25
17#ifndef ANDROID_CONFIGURATION_H 26#ifndef ANDROID_CONFIGURATION_H
18#define ANDROID_CONFIGURATION_H 27#define ANDROID_CONFIGURATION_H
19 28
@@ -24,103 +33,400 @@ extern "C" {
24#endif 33#endif
25 34
26struct AConfiguration; 35struct AConfiguration;
36/**
37 * {@link AConfiguration} is an opaque type used to get and set
38 * various subsystem configurations.
39 *
40 * A {@link AConfiguration} pointer can be obtained using:
41 * - AConfiguration_new()
42 * - AConfiguration_fromAssetManager()
43 */
27typedef struct AConfiguration AConfiguration; 44typedef struct AConfiguration AConfiguration;
28 45
46
47/**
48 * Define flags and constants for various subsystem configurations.
49 */
29enum { 50enum {
51 /** Orientation: not specified. */
30 ACONFIGURATION_ORIENTATION_ANY = 0x0000, 52 ACONFIGURATION_ORIENTATION_ANY = 0x0000,
53 /**
54 * Orientation: value corresponding to the
55 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#OrientationQualifier">port</a>
56 * resource qualifier.
57 */
31 ACONFIGURATION_ORIENTATION_PORT = 0x0001, 58 ACONFIGURATION_ORIENTATION_PORT = 0x0001,
59 /**
60 * Orientation: value corresponding to the
61 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#OrientationQualifier">land</a>
62 * resource qualifier.
63 */
32 ACONFIGURATION_ORIENTATION_LAND = 0x0002, 64 ACONFIGURATION_ORIENTATION_LAND = 0x0002,
65 /** @deprecated Not currently supported or used. */
33 ACONFIGURATION_ORIENTATION_SQUARE = 0x0003, 66 ACONFIGURATION_ORIENTATION_SQUARE = 0x0003,
34 67
68 /** Touchscreen: not specified. */
35 ACONFIGURATION_TOUCHSCREEN_ANY = 0x0000, 69 ACONFIGURATION_TOUCHSCREEN_ANY = 0x0000,
70 /**
71 * Touchscreen: value corresponding to the
72 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#TouchscreenQualifier">notouch</a>
73 * resource qualifier.
74 */
36 ACONFIGURATION_TOUCHSCREEN_NOTOUCH = 0x0001, 75 ACONFIGURATION_TOUCHSCREEN_NOTOUCH = 0x0001,
76 /** @deprecated Not currently supported or used. */
37 ACONFIGURATION_TOUCHSCREEN_STYLUS = 0x0002, 77 ACONFIGURATION_TOUCHSCREEN_STYLUS = 0x0002,
78 /**
79 * Touchscreen: value corresponding to the
80 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#TouchscreenQualifier">finger</a>
81 * resource qualifier.
82 */
38 ACONFIGURATION_TOUCHSCREEN_FINGER = 0x0003, 83 ACONFIGURATION_TOUCHSCREEN_FINGER = 0x0003,
39 84
85 /** Density: default density. */
40 ACONFIGURATION_DENSITY_DEFAULT = 0, 86 ACONFIGURATION_DENSITY_DEFAULT = 0,
87 /**
88 * Density: value corresponding to the
89 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#DensityQualifier">ldpi</a>
90 * resource qualifier.
91 */
41 ACONFIGURATION_DENSITY_LOW = 120, 92 ACONFIGURATION_DENSITY_LOW = 120,
93 /**
94 * Density: value corresponding to the
95 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#DensityQualifier">mdpi</a>
96 * resource qualifier.
97 */
42 ACONFIGURATION_DENSITY_MEDIUM = 160, 98 ACONFIGURATION_DENSITY_MEDIUM = 160,
99 /**
100 * Density: value corresponding to the
101 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#DensityQualifier">tvdpi</a>
102 * resource qualifier.
103 */
43 ACONFIGURATION_DENSITY_TV = 213, 104 ACONFIGURATION_DENSITY_TV = 213,
105 /**
106 * Density: value corresponding to the
107 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#DensityQualifier">hdpi</a>
108 * resource qualifier.
109 */
44 ACONFIGURATION_DENSITY_HIGH = 240, 110 ACONFIGURATION_DENSITY_HIGH = 240,
111 /**
112 * Density: value corresponding to the
113 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#DensityQualifier">xhdpi</a>
114 * resource qualifier.
115 */
45 ACONFIGURATION_DENSITY_XHIGH = 320, 116 ACONFIGURATION_DENSITY_XHIGH = 320,
117 /**
118 * Density: value corresponding to the
119 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#DensityQualifier">xxhdpi</a>
120 * resource qualifier.
121 */
46 ACONFIGURATION_DENSITY_XXHIGH = 480, 122 ACONFIGURATION_DENSITY_XXHIGH = 480,
123 /**
124 * Density: value corresponding to the
125 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#DensityQualifier">xxxhdpi</a>
126 * resource qualifier.
127 */
47 ACONFIGURATION_DENSITY_XXXHIGH = 640, 128 ACONFIGURATION_DENSITY_XXXHIGH = 640,
129 /** Density: any density. */
48 ACONFIGURATION_DENSITY_ANY = 0xfffe, 130 ACONFIGURATION_DENSITY_ANY = 0xfffe,
131 /** Density: no density specified. */
49 ACONFIGURATION_DENSITY_NONE = 0xffff, 132 ACONFIGURATION_DENSITY_NONE = 0xffff,
50 133
134 /** Keyboard: not specified. */
51 ACONFIGURATION_KEYBOARD_ANY = 0x0000, 135 ACONFIGURATION_KEYBOARD_ANY = 0x0000,
136 /**
137 * Keyboard: value corresponding to the
138 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#ImeQualifier">nokeys</a>
139 * resource qualifier.
140 */
52 ACONFIGURATION_KEYBOARD_NOKEYS = 0x0001, 141 ACONFIGURATION_KEYBOARD_NOKEYS = 0x0001,
142 /**
143 * Keyboard: value corresponding to the
144 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#ImeQualifier">qwerty</a>
145 * resource qualifier.
146 */
53 ACONFIGURATION_KEYBOARD_QWERTY = 0x0002, 147 ACONFIGURATION_KEYBOARD_QWERTY = 0x0002,
148 /**
149 * Keyboard: value corresponding to the
150 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#ImeQualifier">12key</a>
151 * resource qualifier.
152 */
54 ACONFIGURATION_KEYBOARD_12KEY = 0x0003, 153 ACONFIGURATION_KEYBOARD_12KEY = 0x0003,
55 154
155 /** Navigation: not specified. */
56 ACONFIGURATION_NAVIGATION_ANY = 0x0000, 156 ACONFIGURATION_NAVIGATION_ANY = 0x0000,
157 /**
158 * Navigation: value corresponding to the
159 * <a href="@@dacRoot/guide/topics/resources/providing-resources.html#NavigationQualifier">nonav</a>
160 * resource qualifier.
161 */
57 ACONFIGURATION_NAVIGATION_NONAV = 0x0001, 162 ACONFIGURATION_NAVIGATION_NONAV = 0x0001,
163 /**
164 * Navigation: value corresponding to the
165 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#NavigationQualifier">dpad</a>
166 * resource qualifier.
167 */
58 ACONFIGURATION_NAVIGATION_DPAD = 0x0002, 168 ACONFIGURATION_NAVIGATION_DPAD = 0x0002,
169 /**
170 * Navigation: value corresponding to the
171 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#NavigationQualifier">trackball</a>
172 * resource qualifier.
173 */
59 ACONFIGURATION_NAVIGATION_TRACKBALL = 0x0003, 174 ACONFIGURATION_NAVIGATION_TRACKBALL = 0x0003,
175 /**
176 * Navigation: value corresponding to the
177 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#NavigationQualifier">wheel</a>
178 * resource qualifier.
179 */
60 ACONFIGURATION_NAVIGATION_WHEEL = 0x0004, 180 ACONFIGURATION_NAVIGATION_WHEEL = 0x0004,
61 181
182 /** Keyboard availability: not specified. */
62 ACONFIGURATION_KEYSHIDDEN_ANY = 0x0000, 183 ACONFIGURATION_KEYSHIDDEN_ANY = 0x0000,
184 /**
185 * Keyboard availability: value corresponding to the
186 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#KeyboardAvailQualifier">keysexposed</a>
187 * resource qualifier.
188 */
63 ACONFIGURATION_KEYSHIDDEN_NO = 0x0001, 189 ACONFIGURATION_KEYSHIDDEN_NO = 0x0001,
190 /**
191 * Keyboard availability: value corresponding to the
192 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#KeyboardAvailQualifier">keyshidden</a>
193 * resource qualifier.
194 */
64 ACONFIGURATION_KEYSHIDDEN_YES = 0x0002, 195 ACONFIGURATION_KEYSHIDDEN_YES = 0x0002,
196 /**
197 * Keyboard availability: value corresponding to the
198 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#KeyboardAvailQualifier">keyssoft</a>
199 * resource qualifier.
200 */
65 ACONFIGURATION_KEYSHIDDEN_SOFT = 0x0003, 201 ACONFIGURATION_KEYSHIDDEN_SOFT = 0x0003,
66 202
203 /** Navigation availability: not specified. */
67 ACONFIGURATION_NAVHIDDEN_ANY = 0x0000, 204 ACONFIGURATION_NAVHIDDEN_ANY = 0x0000,
205 /**
206 * Navigation availability: value corresponding to the
207 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#NavAvailQualifier">navexposed</a>
208 * resource qualifier.
209 */
68 ACONFIGURATION_NAVHIDDEN_NO = 0x0001, 210 ACONFIGURATION_NAVHIDDEN_NO = 0x0001,
211 /**
212 * Navigation availability: value corresponding to the
213 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#NavAvailQualifier">navhidden</a>
214 * resource qualifier.
215 */
69 ACONFIGURATION_NAVHIDDEN_YES = 0x0002, 216 ACONFIGURATION_NAVHIDDEN_YES = 0x0002,
70 217
218 /** Screen size: not specified. */
71 ACONFIGURATION_SCREENSIZE_ANY = 0x00, 219 ACONFIGURATION_SCREENSIZE_ANY = 0x00,
220 /**
221 * Screen size: value indicating the screen is at least
222 * approximately 320x426 dp units, corresponding to the
223 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#ScreenSizeQualifier">small</a>
224 * resource qualifier.
225 */
72 ACONFIGURATION_SCREENSIZE_SMALL = 0x01, 226 ACONFIGURATION_SCREENSIZE_SMALL = 0x01,
227 /**
228 * Screen size: value indicating the screen is at least
229 * approximately 320x470 dp units, corresponding to the
230 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#ScreenSizeQualifier">normal</a>
231 * resource qualifier.
232 */
73 ACONFIGURATION_SCREENSIZE_NORMAL = 0x02, 233 ACONFIGURATION_SCREENSIZE_NORMAL = 0x02,
234 /**
235 * Screen size: value indicating the screen is at least
236 * approximately 480x640 dp units, corresponding to the
237 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#ScreenSizeQualifier">large</a>
238 * resource qualifier.
239 */
74 ACONFIGURATION_SCREENSIZE_LARGE = 0x03, 240 ACONFIGURATION_SCREENSIZE_LARGE = 0x03,
241 /**
242 * Screen size: value indicating the screen is at least
243 * approximately 720x960 dp units, corresponding to the
244 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#ScreenSizeQualifier">xlarge</a>
245 * resource qualifier.
246 */
75 ACONFIGURATION_SCREENSIZE_XLARGE = 0x04, 247 ACONFIGURATION_SCREENSIZE_XLARGE = 0x04,
76 248
249 /** Screen layout: not specified. */
77 ACONFIGURATION_SCREENLONG_ANY = 0x00, 250 ACONFIGURATION_SCREENLONG_ANY = 0x00,
251 /**
252 * Screen layout: value that corresponds to the
253 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#ScreenAspectQualifier">notlong</a>
254 * resource qualifier.
255 */
78 ACONFIGURATION_SCREENLONG_NO = 0x1, 256 ACONFIGURATION_SCREENLONG_NO = 0x1,
257 /**
258 * Screen layout: value that corresponds to the
259 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#ScreenAspectQualifier">long</a>
260 * resource qualifier.
261 */
79 ACONFIGURATION_SCREENLONG_YES = 0x2, 262 ACONFIGURATION_SCREENLONG_YES = 0x2,
80 263
81 ACONFIGURATION_SCREENROUND_ANY = 0x00, 264 ACONFIGURATION_SCREENROUND_ANY = 0x00,
82 ACONFIGURATION_SCREENROUND_NO = 0x1, 265 ACONFIGURATION_SCREENROUND_NO = 0x1,
83 ACONFIGURATION_SCREENROUND_YES = 0x2, 266 ACONFIGURATION_SCREENROUND_YES = 0x2,
84 267
268 /** UI mode: not specified. */
85 ACONFIGURATION_UI_MODE_TYPE_ANY = 0x00, 269 ACONFIGURATION_UI_MODE_TYPE_ANY = 0x00,
270 /**
271 * UI mode: value that corresponds to
272 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#UiModeQualifier">no
273 * UI mode type</a> resource qualifier specified.
274 */
86 ACONFIGURATION_UI_MODE_TYPE_NORMAL = 0x01, 275 ACONFIGURATION_UI_MODE_TYPE_NORMAL = 0x01,
276 /**
277 * UI mode: value that corresponds to
278 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#UiModeQualifier">desk</a> resource qualifier specified.
279 */
87 ACONFIGURATION_UI_MODE_TYPE_DESK = 0x02, 280 ACONFIGURATION_UI_MODE_TYPE_DESK = 0x02,
281 /**
282 * UI mode: value that corresponds to
283 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#UiModeQualifier">car</a> resource qualifier specified.
284 */
88 ACONFIGURATION_UI_MODE_TYPE_CAR = 0x03, 285 ACONFIGURATION_UI_MODE_TYPE_CAR = 0x03,
286 /**
287 * UI mode: value that corresponds to
288 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#UiModeQualifier">television</a> resource qualifier specified.
289 */
89 ACONFIGURATION_UI_MODE_TYPE_TELEVISION = 0x04, 290 ACONFIGURATION_UI_MODE_TYPE_TELEVISION = 0x04,
291 /**
292 * UI mode: value that corresponds to
293 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#UiModeQualifier">appliance</a> resource qualifier specified.
294 */
90 ACONFIGURATION_UI_MODE_TYPE_APPLIANCE = 0x05, 295 ACONFIGURATION_UI_MODE_TYPE_APPLIANCE = 0x05,
296 /**
297 * UI mode: value that corresponds to
298 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#UiModeQualifier">watch</a> resource qualifier specified.
299 */
91 ACONFIGURATION_UI_MODE_TYPE_WATCH = 0x06, 300 ACONFIGURATION_UI_MODE_TYPE_WATCH = 0x06,
92 301
302 /** UI night mode: not specified.*/
93 ACONFIGURATION_UI_MODE_NIGHT_ANY = 0x00, 303 ACONFIGURATION_UI_MODE_NIGHT_ANY = 0x00,
304 /**
305 * UI night mode: value that corresponds to
306 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#NightQualifier">notnight</a> resource qualifier specified.
307 */
94 ACONFIGURATION_UI_MODE_NIGHT_NO = 0x1, 308 ACONFIGURATION_UI_MODE_NIGHT_NO = 0x1,
309 /**
310 * UI night mode: value that corresponds to
311 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#NightQualifier">night</a> resource qualifier specified.
312 */
95 ACONFIGURATION_UI_MODE_NIGHT_YES = 0x2, 313 ACONFIGURATION_UI_MODE_NIGHT_YES = 0x2,
96 314
315 /** Screen width DPI: not specified. */
97 ACONFIGURATION_SCREEN_WIDTH_DP_ANY = 0x0000, 316 ACONFIGURATION_SCREEN_WIDTH_DP_ANY = 0x0000,
98 317
318 /** Screen height DPI: not specified. */
99 ACONFIGURATION_SCREEN_HEIGHT_DP_ANY = 0x0000, 319 ACONFIGURATION_SCREEN_HEIGHT_DP_ANY = 0x0000,
100 320
321 /** Smallest screen width DPI: not specified.*/
101 ACONFIGURATION_SMALLEST_SCREEN_WIDTH_DP_ANY = 0x0000, 322 ACONFIGURATION_SMALLEST_SCREEN_WIDTH_DP_ANY = 0x0000,
102 323
324 /** Layout direction: not specified. */
103 ACONFIGURATION_LAYOUTDIR_ANY = 0x00, 325 ACONFIGURATION_LAYOUTDIR_ANY = 0x00,
326 /**
327 * Layout direction: value that corresponds to
328 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#LayoutDirectionQualifier">ldltr</a> resource qualifier specified.
329 */
104 ACONFIGURATION_LAYOUTDIR_LTR = 0x01, 330 ACONFIGURATION_LAYOUTDIR_LTR = 0x01,
331 /**
332 * Layout direction: value that corresponds to
333 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#LayoutDirectionQualifier">ldrtl</a> resource qualifier specified.
334 */
105 ACONFIGURATION_LAYOUTDIR_RTL = 0x02, 335 ACONFIGURATION_LAYOUTDIR_RTL = 0x02,
106 336
337 /**
338 * Bit mask for
339 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#MccQualifier">mcc</a>
340 * configuration.
341 */
107 ACONFIGURATION_MCC = 0x0001, 342 ACONFIGURATION_MCC = 0x0001,
343 /**
344 * Bit mask for
345 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#MccQualifier">mnc</a>
346 * configuration.
347 */
108 ACONFIGURATION_MNC = 0x0002, 348 ACONFIGURATION_MNC = 0x0002,
349 /**
350 * Bit mask for
351 * <a href="{@docRoot}guide/topics/resources/providing-resources.html#LocaleQualifier">locale</a>
352 * configuration.
353 */
109 ACONFIGURATION_LOCALE = 0x0004, 354 ACONFIGURATION_LOCALE = 0x0004,
355 /**
356 * Bit mask for
357 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#TouchscreenQualifier">touchscreen</a>
358 * configuration.
359 */
110 ACONFIGURATION_TOUCHSCREEN = 0x0008, 360 ACONFIGURATION_TOUCHSCREEN = 0x0008,
361 /**
362 * Bit mask for
363 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#ImeQualifier">keyboard</a>
364 * configuration.
365 */
111 ACONFIGURATION_KEYBOARD = 0x0010, 366 ACONFIGURATION_KEYBOARD = 0x0010,
367 /**
368 * Bit mask for
369 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#KeyboardAvailQualifier">keyboardHidden</a>
370 * configuration.
371 */
112 ACONFIGURATION_KEYBOARD_HIDDEN = 0x0020, 372 ACONFIGURATION_KEYBOARD_HIDDEN = 0x0020,
373 /**
374 * Bit mask for
375 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#NavigationQualifier">navigation</a>
376 * configuration.
377 */
113 ACONFIGURATION_NAVIGATION = 0x0040, 378 ACONFIGURATION_NAVIGATION = 0x0040,
379 /**
380 * Bit mask for
381 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#OrientationQualifier">orientation</a>
382 * configuration.
383 */
114 ACONFIGURATION_ORIENTATION = 0x0080, 384 ACONFIGURATION_ORIENTATION = 0x0080,
385 /**
386 * Bit mask for
387 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#DensityQualifier">density</a>
388 * configuration.
389 */
115 ACONFIGURATION_DENSITY = 0x0100, 390 ACONFIGURATION_DENSITY = 0x0100,
391 /**
392 * Bit mask for
393 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#ScreenSizeQualifier">screen size</a>
394 * configuration.
395 */
116 ACONFIGURATION_SCREEN_SIZE = 0x0200, 396 ACONFIGURATION_SCREEN_SIZE = 0x0200,
397 /**
398 * Bit mask for
399 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#VersionQualifier">platform version</a>
400 * configuration.
401 */
117 ACONFIGURATION_VERSION = 0x0400, 402 ACONFIGURATION_VERSION = 0x0400,
403 /**
404 * Bit mask for screen layout configuration.
405 */
118 ACONFIGURATION_SCREEN_LAYOUT = 0x0800, 406 ACONFIGURATION_SCREEN_LAYOUT = 0x0800,
407 /**
408 * Bit mask for
409 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#UiModeQualifier">ui mode</a>
410 * configuration.
411 */
119 ACONFIGURATION_UI_MODE = 0x1000, 412 ACONFIGURATION_UI_MODE = 0x1000,
413 /**
414 * Bit mask for
415 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#SmallestScreenWidthQualifier">smallest screen width</a>
416 * configuration.
417 */
120 ACONFIGURATION_SMALLEST_SCREEN_SIZE = 0x2000, 418 ACONFIGURATION_SMALLEST_SCREEN_SIZE = 0x2000,
419 /**
420 * Bit mask for
421 * <a href="@dacRoot/guide/topics/resources/providing-resources.html#LayoutDirectionQualifier">layout direction</a>
422 * configuration.
423 */
121 ACONFIGURATION_LAYOUTDIR = 0x4000, 424 ACONFIGURATION_LAYOUTDIR = 0x4000,
122 ACONFIGURATION_SCREEN_ROUND = 0x8000, 425 ACONFIGURATION_SCREEN_ROUND = 0x8000,
123 426 /**
427 * Constant used to to represent MNC (Mobile Network Code) zero.
428 * 0 cannot be used, since it is used to represent an undefined MNC.
429 */
124 ACONFIGURATION_MNC_ZERO = 0xffff, 430 ACONFIGURATION_MNC_ZERO = 0xffff,
125}; 431};
126 432
@@ -137,7 +443,7 @@ void AConfiguration_delete(AConfiguration* config);
137 443
138/** 444/**
139 * Create and return a new AConfiguration based on the current configuration in 445 * Create and return a new AConfiguration based on the current configuration in
140 * use in the given AssetManager. 446 * use in the given {@link AAssetManager}.
141 */ 447 */
142void AConfiguration_fromAssetManager(AConfiguration* out, AAssetManager* am); 448void AConfiguration_fromAssetManager(AConfiguration* out, AAssetManager* am);
143 449
@@ -398,3 +704,5 @@ int32_t AConfiguration_isBetterThan(AConfiguration* base, AConfiguration* test,
398#endif 704#endif
399 705
400#endif // ANDROID_CONFIGURATION_H 706#endif // ANDROID_CONFIGURATION_H
707
708/** @} */
diff --git a/include/android/input.h b/include/android/input.h
index efbbb8558..5ab4e2926 100644
--- a/include/android/input.h
+++ b/include/android/input.h
@@ -14,6 +14,15 @@
14 * limitations under the License. 14 * limitations under the License.
15 */ 15 */
16 16
17/**
18 * @addtogroup Input
19 * @{
20 */
21
22/**
23 * @file input.h
24 */
25
17#ifndef _ANDROID_INPUT_H 26#ifndef _ANDROID_INPUT_H
18#define _ANDROID_INPUT_H 27#define _ANDROID_INPUT_H
19 28
@@ -49,247 +58,271 @@
49extern "C" { 58extern "C" {
50#endif 59#endif
51 60
52/* 61/**
53 * Key states (may be returned by queries about the current state of a 62 * Key states (may be returned by queries about the current state of a
54 * particular key code, scan code or switch). 63 * particular key code, scan code or switch).
55 */ 64 */
56enum { 65enum {
57 /* The key state is unknown or the requested key itself is not supported. */ 66 /** The key state is unknown or the requested key itself is not supported. */
58 AKEY_STATE_UNKNOWN = -1, 67 AKEY_STATE_UNKNOWN = -1,
59 68
60 /* The key is up. */ 69 /** The key is up. */
61 AKEY_STATE_UP = 0, 70 AKEY_STATE_UP = 0,
62 71
63 /* The key is down. */ 72 /** The key is down. */
64 AKEY_STATE_DOWN = 1, 73 AKEY_STATE_DOWN = 1,
65 74
66 /* The key is down but is a virtual key press that is being emulated by the system. */ 75 /** The key is down but is a virtual key press that is being emulated by the system. */
67 AKEY_STATE_VIRTUAL = 2 76 AKEY_STATE_VIRTUAL = 2
68}; 77};
69 78
70/* 79/**
71 * Meta key / modifer state. 80 * Meta key / modifer state.
72 */ 81 */
73enum { 82enum {
74 /* No meta keys are pressed. */ 83 /** No meta keys are pressed. */
75 AMETA_NONE = 0, 84 AMETA_NONE = 0,
76 85
77 /* This mask is used to check whether one of the ALT meta keys is pressed. */ 86 /** This mask is used to check whether one of the ALT meta keys is pressed. */
78 AMETA_ALT_ON = 0x02, 87 AMETA_ALT_ON = 0x02,
79 88
80 /* This mask is used to check whether the left ALT meta key is pressed. */ 89 /** This mask is used to check whether the left ALT meta key is pressed. */
81 AMETA_ALT_LEFT_ON = 0x10, 90 AMETA_ALT_LEFT_ON = 0x10,
82 91
83 /* This mask is used to check whether the right ALT meta key is pressed. */ 92 /** This mask is used to check whether the right ALT meta key is pressed. */
84 AMETA_ALT_RIGHT_ON = 0x20, 93 AMETA_ALT_RIGHT_ON = 0x20,
85 94
86 /* This mask is used to check whether one of the SHIFT meta keys is pressed. */ 95 /** This mask is used to check whether one of the SHIFT meta keys is pressed. */
87 AMETA_SHIFT_ON = 0x01, 96 AMETA_SHIFT_ON = 0x01,
88 97
89 /* This mask is used to check whether the left SHIFT meta key is pressed. */ 98 /** This mask is used to check whether the left SHIFT meta key is pressed. */
90 AMETA_SHIFT_LEFT_ON = 0x40, 99 AMETA_SHIFT_LEFT_ON = 0x40,
91 100
92 /* This mask is used to check whether the right SHIFT meta key is pressed. */ 101 /** This mask is used to check whether the right SHIFT meta key is pressed. */
93 AMETA_SHIFT_RIGHT_ON = 0x80, 102 AMETA_SHIFT_RIGHT_ON = 0x80,
94 103
95 /* This mask is used to check whether the SYM meta key is pressed. */ 104 /** This mask is used to check whether the SYM meta key is pressed. */
96 AMETA_SYM_ON = 0x04, 105 AMETA_SYM_ON = 0x04,
97 106
98 /* This mask is used to check whether the FUNCTION meta key is pressed. */ 107 /** This mask is used to check whether the FUNCTION meta key is pressed. */
99 AMETA_FUNCTION_ON = 0x08, 108 AMETA_FUNCTION_ON = 0x08,
100 109
101 /* This mask is used to check whether one of the CTRL meta keys is pressed. */ 110 /** This mask is used to check whether one of the CTRL meta keys is pressed. */
102 AMETA_CTRL_ON = 0x1000, 111 AMETA_CTRL_ON = 0x1000,
103 112
104 /* This mask is used to check whether the left CTRL meta key is pressed. */ 113 /** This mask is used to check whether the left CTRL meta key is pressed. */
105 AMETA_CTRL_LEFT_ON = 0x2000, 114 AMETA_CTRL_LEFT_ON = 0x2000,
106 115
107 /* This mask is used to check whether the right CTRL meta key is pressed. */ 116 /** This mask is used to check whether the right CTRL meta key is pressed. */
108 AMETA_CTRL_RIGHT_ON = 0x4000, 117 AMETA_CTRL_RIGHT_ON = 0x4000,
109 118
110 /* This mask is used to check whether one of the META meta keys is pressed. */ 119 /** This mask is used to check whether one of the META meta keys is pressed. */
111 AMETA_META_ON = 0x10000, 120 AMETA_META_ON = 0x10000,
112 121
113 /* This mask is used to check whether the left META meta key is pressed. */ 122 /** This mask is used to check whether the left META meta key is pressed. */
114 AMETA_META_LEFT_ON = 0x20000, 123 AMETA_META_LEFT_ON = 0x20000,
115 124
116 /* This mask is used to check whether the right META meta key is pressed. */ 125 /** This mask is used to check whether the right META meta key is pressed. */
117 AMETA_META_RIGHT_ON = 0x40000, 126 AMETA_META_RIGHT_ON = 0x40000,
118 127
119 /* This mask is used to check whether the CAPS LOCK meta key is on. */ 128 /** This mask is used to check whether the CAPS LOCK meta key is on. */
120 AMETA_CAPS_LOCK_ON = 0x100000, 129 AMETA_CAPS_LOCK_ON = 0x100000,
121 130
122 /* This mask is used to check whether the NUM LOCK meta key is on. */ 131 /** This mask is used to check whether the NUM LOCK meta key is on. */
123 AMETA_NUM_LOCK_ON = 0x200000, 132 AMETA_NUM_LOCK_ON = 0x200000,
124 133
125 /* This mask is used to check whether the SCROLL LOCK meta key is on. */ 134 /** This mask is used to check whether the SCROLL LOCK meta key is on. */
126 AMETA_SCROLL_LOCK_ON = 0x400000, 135 AMETA_SCROLL_LOCK_ON = 0x400000,
127}; 136};
128 137
129/* 138struct AInputEvent;
139/**
130 * Input events. 140 * Input events.
131 * 141 *
132 * Input events are opaque structures. Use the provided accessors functions to 142 * Input events are opaque structures. Use the provided accessors functions to
133 * read their properties. 143 * read their properties.
134 */ 144 */
135struct AInputEvent;
136typedef struct AInputEvent AInputEvent; 145typedef struct AInputEvent AInputEvent;
137 146
138/* 147/**
139 * Input event types. 148 * Input event types.
140 */ 149 */
141enum { 150enum {
142 /* Indicates that the input event is a key event. */ 151 /** Indicates that the input event is a key event. */
143 AINPUT_EVENT_TYPE_KEY = 1, 152 AINPUT_EVENT_TYPE_KEY = 1,
144 153
145 /* Indicates that the input event is a motion event. */ 154 /** Indicates that the input event is a motion event. */
146 AINPUT_EVENT_TYPE_MOTION = 2 155 AINPUT_EVENT_TYPE_MOTION = 2
147}; 156};
148 157
149/* 158/**
150 * Key event actions. 159 * Key event actions.
151 */ 160 */
152enum { 161enum {
153 /* The key has been pressed down. */ 162 /** The key has been pressed down. */
154 AKEY_EVENT_ACTION_DOWN = 0, 163 AKEY_EVENT_ACTION_DOWN = 0,
155 164
156 /* The key has been released. */ 165 /** The key has been released. */
157 AKEY_EVENT_ACTION_UP = 1, 166 AKEY_EVENT_ACTION_UP = 1,
158 167
159 /* Multiple duplicate key events have occurred in a row, or a complex string is 168 /**
160 * being delivered. The repeat_count property of the key event contains the number 169 * Multiple duplicate key events have occurred in a row, or a
161 * of times the given key code should be executed. 170 * complex string is being delivered. The repeat_count property
171 * of the key event contains the number of times the given key
172 * code should be executed.
162 */ 173 */
163 AKEY_EVENT_ACTION_MULTIPLE = 2 174 AKEY_EVENT_ACTION_MULTIPLE = 2
164}; 175};
165 176
166/* 177/**
167 * Key event flags. 178 * Key event flags.
168 */ 179 */
169enum { 180enum {
170 /* This mask is set if the device woke because of this key event. */ 181 /** This mask is set if the device woke because of this key event. */
171 AKEY_EVENT_FLAG_WOKE_HERE = 0x1, 182 AKEY_EVENT_FLAG_WOKE_HERE = 0x1,
172 183
173 /* This mask is set if the key event was generated by a software keyboard. */ 184 /** This mask is set if the key event was generated by a software keyboard. */
174 AKEY_EVENT_FLAG_SOFT_KEYBOARD = 0x2, 185 AKEY_EVENT_FLAG_SOFT_KEYBOARD = 0x2,
175 186
176 /* This mask is set if we don't want the key event to cause us to leave touch mode. */ 187 /** This mask is set if we don't want the key event to cause us to leave touch mode. */
177 AKEY_EVENT_FLAG_KEEP_TOUCH_MODE = 0x4, 188 AKEY_EVENT_FLAG_KEEP_TOUCH_MODE = 0x4,
178 189
179 /* This mask is set if an event was known to come from a trusted part 190 /**
180 * of the system. That is, the event is known to come from the user, 191 * This mask is set if an event was known to come from a trusted
181 * and could not have been spoofed by a third party component. */ 192 * part of the system. That is, the event is known to come from
193 * the user, and could not have been spoofed by a third party
194 * component.
195 */
182 AKEY_EVENT_FLAG_FROM_SYSTEM = 0x8, 196 AKEY_EVENT_FLAG_FROM_SYSTEM = 0x8,
183 197
184 /* This mask is used for compatibility, to identify enter keys that are 198 /**
199 * This mask is used for compatibility, to identify enter keys that are
185 * coming from an IME whose enter key has been auto-labelled "next" or 200 * coming from an IME whose enter key has been auto-labelled "next" or
186 * "done". This allows TextView to dispatch these as normal enter keys 201 * "done". This allows TextView to dispatch these as normal enter keys
187 * for old applications, but still do the appropriate action when 202 * for old applications, but still do the appropriate action when
188 * receiving them. */ 203 * receiving them.
204 */
189 AKEY_EVENT_FLAG_EDITOR_ACTION = 0x10, 205 AKEY_EVENT_FLAG_EDITOR_ACTION = 0x10,
190 206
191 /* When associated with up key events, this indicates that the key press 207 /**
208 * When associated with up key events, this indicates that the key press
192 * has been canceled. Typically this is used with virtual touch screen 209 * has been canceled. Typically this is used with virtual touch screen
193 * keys, where the user can slide from the virtual key area on to the 210 * keys, where the user can slide from the virtual key area on to the
194 * display: in that case, the application will receive a canceled up 211 * display: in that case, the application will receive a canceled up
195 * event and should not perform the action normally associated with the 212 * event and should not perform the action normally associated with the
196 * key. Note that for this to work, the application can not perform an 213 * key. Note that for this to work, the application can not perform an
197 * action for a key until it receives an up or the long press timeout has 214 * action for a key until it receives an up or the long press timeout has
198 * expired. */ 215 * expired.
216 */
199 AKEY_EVENT_FLAG_CANCELED = 0x20, 217 AKEY_EVENT_FLAG_CANCELED = 0x20,
200 218
201 /* This key event was generated by a virtual (on-screen) hard key area. 219 /**
220 * This key event was generated by a virtual (on-screen) hard key area.
202 * Typically this is an area of the touchscreen, outside of the regular 221 * Typically this is an area of the touchscreen, outside of the regular
203 * display, dedicated to "hardware" buttons. */ 222 * display, dedicated to "hardware" buttons.
223 */
204 AKEY_EVENT_FLAG_VIRTUAL_HARD_KEY = 0x40, 224 AKEY_EVENT_FLAG_VIRTUAL_HARD_KEY = 0x40,
205 225
206 /* This flag is set for the first key repeat that occurs after the 226 /**
207 * long press timeout. */ 227 * This flag is set for the first key repeat that occurs after the
228 * long press timeout.
229 */
208 AKEY_EVENT_FLAG_LONG_PRESS = 0x80, 230 AKEY_EVENT_FLAG_LONG_PRESS = 0x80,
209 231
210 /* Set when a key event has AKEY_EVENT_FLAG_CANCELED set because a long 232 /**
211 * press action was executed while it was down. */ 233 * Set when a key event has AKEY_EVENT_FLAG_CANCELED set because a long
234 * press action was executed while it was down.
235 */
212 AKEY_EVENT_FLAG_CANCELED_LONG_PRESS = 0x100, 236 AKEY_EVENT_FLAG_CANCELED_LONG_PRESS = 0x100,
213 237
214 /* Set for AKEY_EVENT_ACTION_UP when this event's key code is still being 238 /**
239 * Set for AKEY_EVENT_ACTION_UP when this event's key code is still being
215 * tracked from its initial down. That is, somebody requested that tracking 240 * tracked from its initial down. That is, somebody requested that tracking
216 * started on the key down and a long press has not caused 241 * started on the key down and a long press has not caused
217 * the tracking to be canceled. */ 242 * the tracking to be canceled.
243 */
218 AKEY_EVENT_FLAG_TRACKING = 0x200, 244 AKEY_EVENT_FLAG_TRACKING = 0x200,
219 245
220 /* Set when a key event has been synthesized to implement default behavior 246 /**
247 * Set when a key event has been synthesized to implement default behavior
221 * for an event that the application did not handle. 248 * for an event that the application did not handle.
222 * Fallback key events are generated by unhandled trackball motions 249 * Fallback key events are generated by unhandled trackball motions
223 * (to emulate a directional keypad) and by certain unhandled key presses 250 * (to emulate a directional keypad) and by certain unhandled key presses
224 * that are declared in the key map (such as special function numeric keypad 251 * that are declared in the key map (such as special function numeric keypad
225 * keys when numlock is off). */ 252 * keys when numlock is off).
253 */
226 AKEY_EVENT_FLAG_FALLBACK = 0x400, 254 AKEY_EVENT_FLAG_FALLBACK = 0x400,
227}; 255};
228 256
229/* 257/**
230 * Motion event actions. 258 * Bit shift for the action bits holding the pointer index as
231 */
232
233/* Bit shift for the action bits holding the pointer index as
234 * defined by AMOTION_EVENT_ACTION_POINTER_INDEX_MASK. 259 * defined by AMOTION_EVENT_ACTION_POINTER_INDEX_MASK.
235 */ 260 */
236#define AMOTION_EVENT_ACTION_POINTER_INDEX_SHIFT 8 261#define AMOTION_EVENT_ACTION_POINTER_INDEX_SHIFT 8
237 262
263/** Motion event actions */
238enum { 264enum {
239 /* Bit mask of the parts of the action code that are the action itself. 265 /** Bit mask of the parts of the action code that are the action itself. */
240 */
241 AMOTION_EVENT_ACTION_MASK = 0xff, 266 AMOTION_EVENT_ACTION_MASK = 0xff,
242 267
243 /* Bits in the action code that represent a pointer index, used with 268 /**
269 * Bits in the action code that represent a pointer index, used with
244 * AMOTION_EVENT_ACTION_POINTER_DOWN and AMOTION_EVENT_ACTION_POINTER_UP. Shifting 270 * AMOTION_EVENT_ACTION_POINTER_DOWN and AMOTION_EVENT_ACTION_POINTER_UP. Shifting
245 * down by AMOTION_EVENT_ACTION_POINTER_INDEX_SHIFT provides the actual pointer 271 * down by AMOTION_EVENT_ACTION_POINTER_INDEX_SHIFT provides the actual pointer
246 * index where the data for the pointer going up or down can be found. 272 * index where the data for the pointer going up or down can be found.
247 */ 273 */
248 AMOTION_EVENT_ACTION_POINTER_INDEX_MASK = 0xff00, 274 AMOTION_EVENT_ACTION_POINTER_INDEX_MASK = 0xff00,
249 275
250 /* A pressed gesture has started, the motion contains the initial starting location. 276 /** A pressed gesture has started, the motion contains the initial starting location. */
251 */
252 AMOTION_EVENT_ACTION_DOWN = 0, 277 AMOTION_EVENT_ACTION_DOWN = 0,
253 278
254 /* A pressed gesture has finished, the motion contains the final release location 279 /**
280 * A pressed gesture has finished, the motion contains the final release location
255 * as well as any intermediate points since the last down or move event. 281 * as well as any intermediate points since the last down or move event.
256 */ 282 */
257 AMOTION_EVENT_ACTION_UP = 1, 283 AMOTION_EVENT_ACTION_UP = 1,
258 284
259 /* A change has happened during a press gesture (between AMOTION_EVENT_ACTION_DOWN and 285 /**
286 * A change has happened during a press gesture (between AMOTION_EVENT_ACTION_DOWN and
260 * AMOTION_EVENT_ACTION_UP). The motion contains the most recent point, as well as 287 * AMOTION_EVENT_ACTION_UP). The motion contains the most recent point, as well as
261 * any intermediate points since the last down or move event. 288 * any intermediate points since the last down or move event.
262 */ 289 */
263 AMOTION_EVENT_ACTION_MOVE = 2, 290 AMOTION_EVENT_ACTION_MOVE = 2,
264 291
265 /* The current gesture has been aborted. 292 /**
293 * The current gesture has been aborted.
266 * You will not receive any more points in it. You should treat this as 294 * You will not receive any more points in it. You should treat this as
267 * an up event, but not perform any action that you normally would. 295 * an up event, but not perform any action that you normally would.
268 */ 296 */
269 AMOTION_EVENT_ACTION_CANCEL = 3, 297 AMOTION_EVENT_ACTION_CANCEL = 3,
270 298
271 /* A movement has happened outside of the normal bounds of the UI element. 299 /**
300 * A movement has happened outside of the normal bounds of the UI element.
272 * This does not provide a full gesture, but only the initial location of the movement/touch. 301 * This does not provide a full gesture, but only the initial location of the movement/touch.
273 */ 302 */
274 AMOTION_EVENT_ACTION_OUTSIDE = 4, 303 AMOTION_EVENT_ACTION_OUTSIDE = 4,
275 304
276 /* A non-primary pointer has gone down. 305 /**
306 * A non-primary pointer has gone down.
277 * The bits in AMOTION_EVENT_ACTION_POINTER_INDEX_MASK indicate which pointer changed. 307 * The bits in AMOTION_EVENT_ACTION_POINTER_INDEX_MASK indicate which pointer changed.
278 */ 308 */
279 AMOTION_EVENT_ACTION_POINTER_DOWN = 5, 309 AMOTION_EVENT_ACTION_POINTER_DOWN = 5,
280 310
281 /* A non-primary pointer has gone up. 311 /**
312 * A non-primary pointer has gone up.
282 * The bits in AMOTION_EVENT_ACTION_POINTER_INDEX_MASK indicate which pointer changed. 313 * The bits in AMOTION_EVENT_ACTION_POINTER_INDEX_MASK indicate which pointer changed.
283 */ 314 */
284 AMOTION_EVENT_ACTION_POINTER_UP = 6, 315 AMOTION_EVENT_ACTION_POINTER_UP = 6,
285 316
286 /* A change happened but the pointer is not down (unlike AMOTION_EVENT_ACTION_MOVE). 317 /**
318 * A change happened but the pointer is not down (unlike AMOTION_EVENT_ACTION_MOVE).
287 * The motion contains the most recent point, as well as any intermediate points since 319 * The motion contains the most recent point, as well as any intermediate points since
288 * the last hover move event. 320 * the last hover move event.
289 */ 321 */
290 AMOTION_EVENT_ACTION_HOVER_MOVE = 7, 322 AMOTION_EVENT_ACTION_HOVER_MOVE = 7,
291 323
292 /* The motion event contains relative vertical and/or horizontal scroll offsets. 324 /**
325 * The motion event contains relative vertical and/or horizontal scroll offsets.
293 * Use getAxisValue to retrieve the information from AMOTION_EVENT_AXIS_VSCROLL 326 * Use getAxisValue to retrieve the information from AMOTION_EVENT_AXIS_VSCROLL
294 * and AMOTION_EVENT_AXIS_HSCROLL. 327 * and AMOTION_EVENT_AXIS_HSCROLL.
295 * The pointer may or may not be down when this event is dispatched. 328 * The pointer may or may not be down when this event is dispatched.
@@ -298,12 +331,10 @@ enum {
298 */ 331 */
299 AMOTION_EVENT_ACTION_SCROLL = 8, 332 AMOTION_EVENT_ACTION_SCROLL = 8,
300 333
301 /* The pointer is not down but has entered the boundaries of a window or view. 334 /** The pointer is not down but has entered the boundaries of a window or view. */
302 */
303 AMOTION_EVENT_ACTION_HOVER_ENTER = 9, 335 AMOTION_EVENT_ACTION_HOVER_ENTER = 9,
304 336
305 /* The pointer is not down but has exited the boundaries of a window or view. 337 /** The pointer is not down but has exited the boundaries of a window or view. */
306 */
307 AMOTION_EVENT_ACTION_HOVER_EXIT = 10, 338 AMOTION_EVENT_ACTION_HOVER_EXIT = 10,
308 339
309 /* One or more buttons have been pressed. */ 340 /* One or more buttons have been pressed. */
@@ -313,11 +344,12 @@ enum {
313 AMOTION_EVENT_ACTION_BUTTON_RELEASE = 12, 344 AMOTION_EVENT_ACTION_BUTTON_RELEASE = 12,
314}; 345};
315 346
316/* 347/**
317 * Motion event flags. 348 * Motion event flags.
318 */ 349 */
319enum { 350enum {
320 /* This flag indicates that the window that received this motion event is partly 351 /**
352 * This flag indicates that the window that received this motion event is partly
321 * or wholly obscured by another visible window above it. This flag is set to true 353 * or wholly obscured by another visible window above it. This flag is set to true
322 * even if the event did not directly pass through the obscured area. 354 * even if the event did not directly pass through the obscured area.
323 * A security sensitive application can check this flag to identify situations in which 355 * A security sensitive application can check this flag to identify situations in which
@@ -329,173 +361,513 @@ enum {
329 AMOTION_EVENT_FLAG_WINDOW_IS_OBSCURED = 0x1, 361 AMOTION_EVENT_FLAG_WINDOW_IS_OBSCURED = 0x1,
330}; 362};
331 363
332/* 364/**
333 * Motion event edge touch flags. 365 * Motion event edge touch flags.
334 */ 366 */
335enum { 367enum {
336 /* No edges intersected */ 368 /** No edges intersected. */
337 AMOTION_EVENT_EDGE_FLAG_NONE = 0, 369 AMOTION_EVENT_EDGE_FLAG_NONE = 0,
338 370
339 /* Flag indicating the motion event intersected the top edge of the screen. */ 371 /** Flag indicating the motion event intersected the top edge of the screen. */
340 AMOTION_EVENT_EDGE_FLAG_TOP = 0x01, 372 AMOTION_EVENT_EDGE_FLAG_TOP = 0x01,
341 373
342 /* Flag indicating the motion event intersected the bottom edge of the screen. */ 374 /** Flag indicating the motion event intersected the bottom edge of the screen. */
343 AMOTION_EVENT_EDGE_FLAG_BOTTOM = 0x02, 375 AMOTION_EVENT_EDGE_FLAG_BOTTOM = 0x02,
344 376
345 /* Flag indicating the motion event intersected the left edge of the screen. */ 377 /** Flag indicating the motion event intersected the left edge of the screen. */
346 AMOTION_EVENT_EDGE_FLAG_LEFT = 0x04, 378 AMOTION_EVENT_EDGE_FLAG_LEFT = 0x04,
347 379
348 /* Flag indicating the motion event intersected the right edge of the screen. */ 380 /** Flag indicating the motion event intersected the right edge of the screen. */
349 AMOTION_EVENT_EDGE_FLAG_RIGHT = 0x08 381 AMOTION_EVENT_EDGE_FLAG_RIGHT = 0x08
350}; 382};
351 383
352/* 384/**
353 * Constants that identify each individual axis of a motion event. 385 * Constants that identify each individual axis of a motion event.
354 * Refer to the documentation on the MotionEvent class for descriptions of each axis. 386 * @anchor AMOTION_EVENT_AXIS
355 */ 387 */
356enum { 388enum {
389 /**
390 * Axis constant: X axis of a motion event.
391 *
392 * - For a touch screen, reports the absolute X screen position of the center of
393 * the touch contact area. The units are display pixels.
394 * - For a touch pad, reports the absolute X surface position of the center of the touch
395 * contact area. The units are device-dependent.
396 * - For a mouse, reports the absolute X screen position of the mouse pointer.
397 * The units are display pixels.
398 * - For a trackball, reports the relative horizontal displacement of the trackball.
399 * The value is normalized to a range from -1.0 (left) to 1.0 (right).
400 * - For a joystick, reports the absolute X position of the joystick.
401 * The value is normalized to a range from -1.0 (left) to 1.0 (right).
402 */
357 AMOTION_EVENT_AXIS_X = 0, 403 AMOTION_EVENT_AXIS_X = 0,
404 /**
405 * Axis constant: Y axis of a motion event.
406 *
407 * - For a touch screen, reports the absolute Y screen position of the center of
408 * the touch contact area. The units are display pixels.
409 * - For a touch pad, reports the absolute Y surface position of the center of the touch
410 * contact area. The units are device-dependent.
411 * - For a mouse, reports the absolute Y screen position of the mouse pointer.
412 * The units are display pixels.
413 * - For a trackball, reports the relative vertical displacement of the trackball.
414 * The value is normalized to a range from -1.0 (up) to 1.0 (down).
415 * - For a joystick, reports the absolute Y position of the joystick.
416 * The value is normalized to a range from -1.0 (up or far) to 1.0 (down or near).
417 */
358 AMOTION_EVENT_AXIS_Y = 1, 418 AMOTION_EVENT_AXIS_Y = 1,
419 /**
420 * Axis constant: Pressure axis of a motion event.
421 *
422 * - For a touch screen or touch pad, reports the approximate pressure applied to the surface
423 * by a finger or other tool. The value is normalized to a range from
424 * 0 (no pressure at all) to 1 (normal pressure), although values higher than 1
425 * may be generated depending on the calibration of the input device.
426 * - For a trackball, the value is set to 1 if the trackball button is pressed
427 * or 0 otherwise.
428 * - For a mouse, the value is set to 1 if the primary mouse button is pressed
429 * or 0 otherwise.
430 */
359 AMOTION_EVENT_AXIS_PRESSURE = 2, 431 AMOTION_EVENT_AXIS_PRESSURE = 2,
432 /**
433 * Axis constant: Size axis of a motion event.
434 *
435 * - For a touch screen or touch pad, reports the approximate size of the contact area in
436 * relation to the maximum detectable size for the device. The value is normalized
437 * to a range from 0 (smallest detectable size) to 1 (largest detectable size),
438 * although it is not a linear scale. This value is of limited use.
439 * To obtain calibrated size information, see
440 * {@link AMOTION_EVENT_AXIS_TOUCH_MAJOR} or {@link AMOTION_EVENT_AXIS_TOOL_MAJOR}.
441 */
360 AMOTION_EVENT_AXIS_SIZE = 3, 442 AMOTION_EVENT_AXIS_SIZE = 3,
443 /**
444 * Axis constant: TouchMajor axis of a motion event.
445 *
446 * - For a touch screen, reports the length of the major axis of an ellipse that
447 * represents the touch area at the point of contact.
448 * The units are display pixels.
449 * - For a touch pad, reports the length of the major axis of an ellipse that
450 * represents the touch area at the point of contact.
451 * The units are device-dependent.
452 */
361 AMOTION_EVENT_AXIS_TOUCH_MAJOR = 4, 453 AMOTION_EVENT_AXIS_TOUCH_MAJOR = 4,
454 /**
455 * Axis constant: TouchMinor axis of a motion event.
456 *
457 * - For a touch screen, reports the length of the minor axis of an ellipse that
458 * represents the touch area at the point of contact.
459 * The units are display pixels.
460 * - For a touch pad, reports the length of the minor axis of an ellipse that
461 * represents the touch area at the point of contact.
462 * The units are device-dependent.
463 *
464 * When the touch is circular, the major and minor axis lengths will be equal to one another.
465 */
362 AMOTION_EVENT_AXIS_TOUCH_MINOR = 5, 466 AMOTION_EVENT_AXIS_TOUCH_MINOR = 5,
467 /**
468 * Axis constant: ToolMajor axis of a motion event.
469 *
470 * - For a touch screen, reports the length of the major axis of an ellipse that
471 * represents the size of the approaching finger or tool used to make contact.
472 * - For a touch pad, reports the length of the major axis of an ellipse that
473 * represents the size of the approaching finger or tool used to make contact.
474 * The units are device-dependent.
475 *
476 * When the touch is circular, the major and minor axis lengths will be equal to one another.
477 *
478 * The tool size may be larger than the touch size since the tool may not be fully
479 * in contact with the touch sensor.
480 */
363 AMOTION_EVENT_AXIS_TOOL_MAJOR = 6, 481 AMOTION_EVENT_AXIS_TOOL_MAJOR = 6,
482 /**
483 * Axis constant: ToolMinor axis of a motion event.
484 *
485 * - For a touch screen, reports the length of the minor axis of an ellipse that
486 * represents the size of the approaching finger or tool used to make contact.
487 * - For a touch pad, reports the length of the minor axis of an ellipse that
488 * represents the size of the approaching finger or tool used to make contact.
489 * The units are device-dependent.
490 *
491 * When the touch is circular, the major and minor axis lengths will be equal to one another.
492 *
493 * The tool size may be larger than the touch size since the tool may not be fully
494 * in contact with the touch sensor.
495 */
364 AMOTION_EVENT_AXIS_TOOL_MINOR = 7, 496 AMOTION_EVENT_AXIS_TOOL_MINOR = 7,
497 /**
498 * Axis constant: Orientation axis of a motion event.
499 *
500 * - For a touch screen or touch pad, reports the orientation of the finger
501 * or tool in radians relative to the vertical plane of the device.
502 * An angle of 0 radians indicates that the major axis of contact is oriented
503 * upwards, is perfectly circular or is of unknown orientation. A positive angle
504 * indicates that the major axis of contact is oriented to the right. A negative angle
505 * indicates that the major axis of contact is oriented to the left.
506 * The full range is from -PI/2 radians (finger pointing fully left) to PI/2 radians
507 * (finger pointing fully right).
508 * - For a stylus, the orientation indicates the direction in which the stylus
509 * is pointing in relation to the vertical axis of the current orientation of the screen.
510 * The range is from -PI radians to PI radians, where 0 is pointing up,
511 * -PI/2 radians is pointing left, -PI or PI radians is pointing down, and PI/2 radians
512 * is pointing right. See also {@link AMOTION_EVENT_AXIS_TILT}.
513 */
365 AMOTION_EVENT_AXIS_ORIENTATION = 8, 514 AMOTION_EVENT_AXIS_ORIENTATION = 8,
515 /**
516 * Axis constant: Vertical Scroll axis of a motion event.
517 *
518 * - For a mouse, reports the relative movement of the vertical scroll wheel.
519 * The value is normalized to a range from -1.0 (down) to 1.0 (up).
520 *
521 * This axis should be used to scroll views vertically.
522 */
366 AMOTION_EVENT_AXIS_VSCROLL = 9, 523 AMOTION_EVENT_AXIS_VSCROLL = 9,
524 /**
525 * Axis constant: Horizontal Scroll axis of a motion event.
526 *
527 * - For a mouse, reports the relative movement of the horizontal scroll wheel.
528 * The value is normalized to a range from -1.0 (left) to 1.0 (right).
529 *
530 * This axis should be used to scroll views horizontally.
531 */
367 AMOTION_EVENT_AXIS_HSCROLL = 10, 532 AMOTION_EVENT_AXIS_HSCROLL = 10,
533 /**
534 * Axis constant: Z axis of a motion event.
535 *
536 * - For a joystick, reports the absolute Z position of the joystick.
537 * The value is normalized to a range from -1.0 (high) to 1.0 (low).
538 * <em>On game pads with two analog joysticks, this axis is often reinterpreted
539 * to report the absolute X position of the second joystick instead.</em>
540 */
368 AMOTION_EVENT_AXIS_Z = 11, 541 AMOTION_EVENT_AXIS_Z = 11,
542 /**
543 * Axis constant: X Rotation axis of a motion event.
544 *
545 * - For a joystick, reports the absolute rotation angle about the X axis.
546 * The value is normalized to a range from -1.0 (counter-clockwise) to 1.0 (clockwise).
547 */
369 AMOTION_EVENT_AXIS_RX = 12, 548 AMOTION_EVENT_AXIS_RX = 12,
549 /**
550 * Axis constant: Y Rotation axis of a motion event.
551 *
552 * - For a joystick, reports the absolute rotation angle about the Y axis.
553 * The value is normalized to a range from -1.0 (counter-clockwise) to 1.0 (clockwise).
554 */
370 AMOTION_EVENT_AXIS_RY = 13, 555 AMOTION_EVENT_AXIS_RY = 13,
556 /**
557 * Axis constant: Z Rotation axis of a motion event.
558 *
559 * - For a joystick, reports the absolute rotation angle about the Z axis.
560 * The value is normalized to a range from -1.0 (counter-clockwise) to 1.0 (clockwise).
561 * On game pads with two analog joysticks, this axis is often reinterpreted
562 * to report the absolute Y position of the second joystick instead.
563 */
371 AMOTION_EVENT_AXIS_RZ = 14, 564 AMOTION_EVENT_AXIS_RZ = 14,
565 /**
566 * Axis constant: Hat X axis of a motion event.
567 *
568 * - For a joystick, reports the absolute X position of the directional hat control.
569 * The value is normalized to a range from -1.0 (left) to 1.0 (right).
570 */
372 AMOTION_EVENT_AXIS_HAT_X = 15, 571 AMOTION_EVENT_AXIS_HAT_X = 15,
572 /**
573 * Axis constant: Hat Y axis of a motion event.
574 *
575 * - For a joystick, reports the absolute Y position of the directional hat control.
576 * The value is normalized to a range from -1.0 (up) to 1.0 (down).
577 */
373 AMOTION_EVENT_AXIS_HAT_Y = 16, 578 AMOTION_EVENT_AXIS_HAT_Y = 16,
579 /**
580 * Axis constant: Left Trigger axis of a motion event.
581 *
582 * - For a joystick, reports the absolute position of the left trigger control.
583 * The value is normalized to a range from 0.0 (released) to 1.0 (fully pressed).
584 */
374 AMOTION_EVENT_AXIS_LTRIGGER = 17, 585 AMOTION_EVENT_AXIS_LTRIGGER = 17,
586 /**
587 * Axis constant: Right Trigger axis of a motion event.
588 *
589 * - For a joystick, reports the absolute position of the right trigger control.
590 * The value is normalized to a range from 0.0 (released) to 1.0 (fully pressed).
591 */
375 AMOTION_EVENT_AXIS_RTRIGGER = 18, 592 AMOTION_EVENT_AXIS_RTRIGGER = 18,
593 /**
594 * Axis constant: Throttle axis of a motion event.
595 *
596 * - For a joystick, reports the absolute position of the throttle control.
597 * The value is normalized to a range from 0.0 (fully open) to 1.0 (fully closed).
598 */
376 AMOTION_EVENT_AXIS_THROTTLE = 19, 599 AMOTION_EVENT_AXIS_THROTTLE = 19,
600 /**
601 * Axis constant: Rudder axis of a motion event.
602 *
603 * - For a joystick, reports the absolute position of the rudder control.
604 * The value is normalized to a range from -1.0 (turn left) to 1.0 (turn right).
605 */
377 AMOTION_EVENT_AXIS_RUDDER = 20, 606 AMOTION_EVENT_AXIS_RUDDER = 20,
607 /**
608 * Axis constant: Wheel axis of a motion event.
609 *
610 * - For a joystick, reports the absolute position of the steering wheel control.
611 * The value is normalized to a range from -1.0 (turn left) to 1.0 (turn right).
612 */
378 AMOTION_EVENT_AXIS_WHEEL = 21, 613 AMOTION_EVENT_AXIS_WHEEL = 21,
614 /**
615 * Axis constant: Gas axis of a motion event.
616 *
617 * - For a joystick, reports the absolute position of the gas (accelerator) control.
618 * The value is normalized to a range from 0.0 (no acceleration)
619 * to 1.0 (maximum acceleration).
620 */
379 AMOTION_EVENT_AXIS_GAS = 22, 621 AMOTION_EVENT_AXIS_GAS = 22,
622 /**
623 * Axis constant: Brake axis of a motion event.
624 *
625 * - For a joystick, reports the absolute position of the brake control.
626 * The value is normalized to a range from 0.0 (no braking) to 1.0 (maximum braking).
627 */
380 AMOTION_EVENT_AXIS_BRAKE = 23, 628 AMOTION_EVENT_AXIS_BRAKE = 23,
629 /**
630 * Axis constant: Distance axis of a motion event.
631 *
632 * - For a stylus, reports the distance of the stylus from the screen.
633 * A value of 0.0 indicates direct contact and larger values indicate increasing
634 * distance from the surface.
635 */
381 AMOTION_EVENT_AXIS_DISTANCE = 24, 636 AMOTION_EVENT_AXIS_DISTANCE = 24,
637 /**
638 * Axis constant: Tilt axis of a motion event.
639 *
640 * - For a stylus, reports the tilt angle of the stylus in radians where
641 * 0 radians indicates that the stylus is being held perpendicular to the
642 * surface, and PI/2 radians indicates that the stylus is being held flat
643 * against the surface.
644 */
382 AMOTION_EVENT_AXIS_TILT = 25, 645 AMOTION_EVENT_AXIS_TILT = 25,
646 /**
647 * Axis constant: Generic 1 axis of a motion event.
648 * The interpretation of a generic axis is device-specific.
649 */
383 AMOTION_EVENT_AXIS_GENERIC_1 = 32, 650 AMOTION_EVENT_AXIS_GENERIC_1 = 32,
651 /**
652 * Axis constant: Generic 2 axis of a motion event.
653 * The interpretation of a generic axis is device-specific.
654 */
384 AMOTION_EVENT_AXIS_GENERIC_2 = 33, 655 AMOTION_EVENT_AXIS_GENERIC_2 = 33,
656 /**
657 * Axis constant: Generic 3 axis of a motion event.
658 * The interpretation of a generic axis is device-specific.
659 */
385 AMOTION_EVENT_AXIS_GENERIC_3 = 34, 660 AMOTION_EVENT_AXIS_GENERIC_3 = 34,
661 /**
662 * Axis constant: Generic 4 axis of a motion event.
663 * The interpretation of a generic axis is device-specific.
664 */
386 AMOTION_EVENT_AXIS_GENERIC_4 = 35, 665 AMOTION_EVENT_AXIS_GENERIC_4 = 35,
666 /**
667 * Axis constant: Generic 5 axis of a motion event.
668 * The interpretation of a generic axis is device-specific.
669 */
387 AMOTION_EVENT_AXIS_GENERIC_5 = 36, 670 AMOTION_EVENT_AXIS_GENERIC_5 = 36,
671 /**
672 * Axis constant: Generic 6 axis of a motion event.
673 * The interpretation of a generic axis is device-specific.
674 */
388 AMOTION_EVENT_AXIS_GENERIC_6 = 37, 675 AMOTION_EVENT_AXIS_GENERIC_6 = 37,
676 /**
677 * Axis constant: Generic 7 axis of a motion event.
678 * The interpretation of a generic axis is device-specific.
679 */
389 AMOTION_EVENT_AXIS_GENERIC_7 = 38, 680 AMOTION_EVENT_AXIS_GENERIC_7 = 38,
681 /**
682 * Axis constant: Generic 8 axis of a motion event.
683 * The interpretation of a generic axis is device-specific.
684 */
390 AMOTION_EVENT_AXIS_GENERIC_8 = 39, 685 AMOTION_EVENT_AXIS_GENERIC_8 = 39,
686 /**
687 * Axis constant: Generic 9 axis of a motion event.
688 * The interpretation of a generic axis is device-specific.
689 */
391 AMOTION_EVENT_AXIS_GENERIC_9 = 40, 690 AMOTION_EVENT_AXIS_GENERIC_9 = 40,
691 /**
692 * Axis constant: Generic 10 axis of a motion event.
693 * The interpretation of a generic axis is device-specific.
694 */
392 AMOTION_EVENT_AXIS_GENERIC_10 = 41, 695 AMOTION_EVENT_AXIS_GENERIC_10 = 41,
696 /**
697 * Axis constant: Generic 11 axis of a motion event.
698 * The interpretation of a generic axis is device-specific.
699 */
393 AMOTION_EVENT_AXIS_GENERIC_11 = 42, 700 AMOTION_EVENT_AXIS_GENERIC_11 = 42,
701 /**
702 * Axis constant: Generic 12 axis of a motion event.
703 * The interpretation of a generic axis is device-specific.
704 */
394 AMOTION_EVENT_AXIS_GENERIC_12 = 43, 705 AMOTION_EVENT_AXIS_GENERIC_12 = 43,
706 /**
707 * Axis constant: Generic 13 axis of a motion event.
708 * The interpretation of a generic axis is device-specific.
709 */
395 AMOTION_EVENT_AXIS_GENERIC_13 = 44, 710 AMOTION_EVENT_AXIS_GENERIC_13 = 44,
711 /**
712 * Axis constant: Generic 14 axis of a motion event.
713 * The interpretation of a generic axis is device-specific.
714 */
396 AMOTION_EVENT_AXIS_GENERIC_14 = 45, 715 AMOTION_EVENT_AXIS_GENERIC_14 = 45,
716 /**
717 * Axis constant: Generic 15 axis of a motion event.
718 * The interpretation of a generic axis is device-specific.
719 */
397 AMOTION_EVENT_AXIS_GENERIC_15 = 46, 720 AMOTION_EVENT_AXIS_GENERIC_15 = 46,
721 /**
722 * Axis constant: Generic 16 axis of a motion event.
723 * The interpretation of a generic axis is device-specific.
724 */
398 AMOTION_EVENT_AXIS_GENERIC_16 = 47, 725 AMOTION_EVENT_AXIS_GENERIC_16 = 47,
399 726
400 // NOTE: If you add a new axis here you must also add it to several other files. 727 // NOTE: If you add a new axis here you must also add it to several other files.
401 // Refer to frameworks/base/core/java/android/view/MotionEvent.java for the full list. 728 // Refer to frameworks/base/core/java/android/view/MotionEvent.java for the full list.
402}; 729};
403 730
404/* 731/**
405 * Constants that identify buttons that are associated with motion events. 732 * Constants that identify buttons that are associated with motion events.
406 * Refer to the documentation on the MotionEvent class for descriptions of each button. 733 * Refer to the documentation on the MotionEvent class for descriptions of each button.
407 */ 734 */
408enum { 735enum {
736 /** primary */
409 AMOTION_EVENT_BUTTON_PRIMARY = 1 << 0, 737 AMOTION_EVENT_BUTTON_PRIMARY = 1 << 0,
738 /** secondary */
410 AMOTION_EVENT_BUTTON_SECONDARY = 1 << 1, 739 AMOTION_EVENT_BUTTON_SECONDARY = 1 << 1,
740 /** tertiary */
411 AMOTION_EVENT_BUTTON_TERTIARY = 1 << 2, 741 AMOTION_EVENT_BUTTON_TERTIARY = 1 << 2,
742 /** back */
412 AMOTION_EVENT_BUTTON_BACK = 1 << 3, 743 AMOTION_EVENT_BUTTON_BACK = 1 << 3,
744 /** forward */
413 AMOTION_EVENT_BUTTON_FORWARD = 1 << 4, 745 AMOTION_EVENT_BUTTON_FORWARD = 1 << 4,
414 AMOTION_EVENT_BUTTON_STYLUS_PRIMARY = 1 << 5, 746 AMOTION_EVENT_BUTTON_STYLUS_PRIMARY = 1 << 5,
415 AMOTION_EVENT_BUTTON_STYLUS_SECONDARY = 1 << 6, 747 AMOTION_EVENT_BUTTON_STYLUS_SECONDARY = 1 << 6,
416}; 748};
417 749
418/* 750/**
419 * Constants that identify tool types. 751 * Constants that identify tool types.
420 * Refer to the documentation on the MotionEvent class for descriptions of each tool type. 752 * Refer to the documentation on the MotionEvent class for descriptions of each tool type.
421 */ 753 */
422enum { 754enum {
755 /** unknown */
423 AMOTION_EVENT_TOOL_TYPE_UNKNOWN = 0, 756 AMOTION_EVENT_TOOL_TYPE_UNKNOWN = 0,
757 /** finger */
424 AMOTION_EVENT_TOOL_TYPE_FINGER = 1, 758 AMOTION_EVENT_TOOL_TYPE_FINGER = 1,
759 /** stylus */
425 AMOTION_EVENT_TOOL_TYPE_STYLUS = 2, 760 AMOTION_EVENT_TOOL_TYPE_STYLUS = 2,
761 /** mouse */
426 AMOTION_EVENT_TOOL_TYPE_MOUSE = 3, 762 AMOTION_EVENT_TOOL_TYPE_MOUSE = 3,
763 /** eraser */
427 AMOTION_EVENT_TOOL_TYPE_ERASER = 4, 764 AMOTION_EVENT_TOOL_TYPE_ERASER = 4,
428}; 765};
429 766
430/* 767/**
431 * Input sources. 768 * Input source masks.
432 * 769 *
433 * Refer to the documentation on android.view.InputDevice for more details about input sources 770 * Refer to the documentation on android.view.InputDevice for more details about input sources
434 * and their correct interpretation. 771 * and their correct interpretation.
435 */ 772 */
436enum { 773enum {
774 /** mask */
437 AINPUT_SOURCE_CLASS_MASK = 0x000000ff, 775 AINPUT_SOURCE_CLASS_MASK = 0x000000ff,
438 776
777 /** none */
439 AINPUT_SOURCE_CLASS_NONE = 0x00000000, 778 AINPUT_SOURCE_CLASS_NONE = 0x00000000,
779 /** button */
440 AINPUT_SOURCE_CLASS_BUTTON = 0x00000001, 780 AINPUT_SOURCE_CLASS_BUTTON = 0x00000001,
781 /** pointer */
441 AINPUT_SOURCE_CLASS_POINTER = 0x00000002, 782 AINPUT_SOURCE_CLASS_POINTER = 0x00000002,
783 /** navigation */
442 AINPUT_SOURCE_CLASS_NAVIGATION = 0x00000004, 784 AINPUT_SOURCE_CLASS_NAVIGATION = 0x00000004,
785 /** position */
443 AINPUT_SOURCE_CLASS_POSITION = 0x00000008, 786 AINPUT_SOURCE_CLASS_POSITION = 0x00000008,
787 /** joystick */
444 AINPUT_SOURCE_CLASS_JOYSTICK = 0x00000010, 788 AINPUT_SOURCE_CLASS_JOYSTICK = 0x00000010,
445}; 789};
446 790
791/**
792 * Input sources.
793 */
447enum { 794enum {
795 /** unknown */
448 AINPUT_SOURCE_UNKNOWN = 0x00000000, 796 AINPUT_SOURCE_UNKNOWN = 0x00000000,
449 797
798 /** keyboard */
450 AINPUT_SOURCE_KEYBOARD = 0x00000100 | AINPUT_SOURCE_CLASS_BUTTON, 799 AINPUT_SOURCE_KEYBOARD = 0x00000100 | AINPUT_SOURCE_CLASS_BUTTON,
800 /** dpad */
451 AINPUT_SOURCE_DPAD = 0x00000200 | AINPUT_SOURCE_CLASS_BUTTON, 801 AINPUT_SOURCE_DPAD = 0x00000200 | AINPUT_SOURCE_CLASS_BUTTON,
802 /** gamepad */
452 AINPUT_SOURCE_GAMEPAD = 0x00000400 | AINPUT_SOURCE_CLASS_BUTTON, 803 AINP