Ubuntu Platform API  2.3.0
A library helping with tight integration into the Ubuntu platform
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
/build/buildd/platform-api-2.4.0+14.10.20140929/doc/mainpage.md
Go to the documentation of this file.
1 Ubuntu Platform API {#mainpage}
2 ===================
3 
4 The Ubuntu platform API Implements access to the Ubuntu platform and
5 is the primary carrier across form-factor boundaries. It serves as a
6 low-level access layer to the underlying system and its capabilities.
7 
8 Intended Audience
9 -----------------
10 
11 The intended audience of this API and its documentation are
12 integrators and developers who either cannot or do not want to rely on
13 the more convenient QML or HTML5/JS SDKs.
14 
15 Source Tree Layout
16 ------------------
17 
18 The overall source tree is split up into roughly two parts:
19 
20  * include/
21  * ubuntu/
22  * application/
23  * ui/
24  * sensors/
25  * ui/
26  * android/
27 
28 where include contains all of the public types, functions and
29 interfaces offered by the Ubuntu platform API. The android subfolder
30 contains the android-specific implementation of the Ubuntu platform
31 API, together with a default implementation of the C API on top of the
32 generic C++ API. For developers, only the include/ folder and its
33 subdirectories are of interest.
34 
35 Within the include/ folder, only the ubuntu/application/ subfolder is
36 meant for public consumption. Please note that all the interfaces
37 defined in ubuntu/ui are considered private at this point and are
38 likely to see significant changes or might completely go away without
39 prior notice.