doc/appfw_app_common_doc.h

   1 /*
   2  * Copyright (c) 2014 - 2016 Samsung Electronics Co., Ltd All Rights Reserved
   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
  18 #ifndef __TIZEN_APPFW_APP_COMMON_DOC_H__
  19 #define __TIZEN_APPFW_APP_COMMON_DOC_H__
  20
  21  /**
  22  * @ingroup CAPI_APPLICATION_MODULE
  23  * @defgroup CAPI_APP_COMMON_MODULE App Common
  24  * @addtogroup CAPI_APP_COMMON_MODULE
  25  * @brief The @ref CAPI_APP_COMMON_MODULE API provides functions for getting information about the application.
  26  * @section CAPI_APP_COMMON_MODULE_HEADER Required Header
  27  *   \#include <app_common.h>
  28
  29  * @section CAPI_APP_COMMON_MODULE_OVERVIEW Overview
  30  * The App common API provides common APIs that can be used at UI application and Service application.
  31  * This API provides interfaces for getting information about the application.
  32  *
  33  * @subsection CAPI_APPLICATION_MODULE_PACKAGE Application Package
  34  * The Tizen native application consists of structured directories to manage the application executable file, library files, resource files, and data.
  35  * When you build the application, the Tizen SDK packages those as an application package for distribution.
  36  *
  37  * @image html capi_appfw_application_package.png "Application package"
  38  * <table>
  39  * <tr>
  40  * <th>Directories</th>
  41  * <th>Description</th>
  42  * </tr>
  43  * <tr>
  44  * <td>&lt;package id&gt;</td>
  45  * <td>The fully qualified name of an application (such as org.tizen.calculator).</td>
  46  * </tr>
  47  * <tr>
  48  * <td>bin</td>
  49  * <td>The executable file of the application.</td>
  50  * </tr>
  51  * <tr>
  52  * <td>lib</td>
  53  * <td>The application library files</td>
  54  * </tr>
  55  * <tr>
  56  * <td>res</td>
  57  * <td>The root directory in which all resource files are located.\n
  58  * The application cannot write and modify any resource files</td>
  59  * </tr>
  60  * <tr>
  61  * <td>data</td>
  62  * <td>The root directory in which an application's private data is located.\n
  63  * The application can read and write its own data files in the application's data directory.</td>
  64  * </tr>
  65  * <tr>
  66  * <td>shared/</td>
  67  * <td>The shared directory for sharing with other applications.</td>
  68  * </tr>
  69  * </table>
  70  *
  71  * @subsection CAPI_APPLICATION_MODULE_GET_INFORMATION Getting Information About the Application
  72  * The API provides functions for obtaining an application's package name and absolute path to specified resources
  73  * like Image, Sound, Video, UI layout (EDJ), and so on.
  74  * It also provides functions to:
  75  * - Get the current orientation of the device
  76  * - Get the Internal/External root folders which are shared among all applications
  77  */
  78
  79 #endif /* __TIZEN_APPFW_APP_COMMON_DOC_H__ */
  80