doc/attach_panel_doc.h

   1 /*
   2  * Copyright (c) 2015 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 #ifndef __TIZEN_ATTACH_PANEL_DOC_H__
  18 #define __TIZEN_ATTACH_PANEL_DOC_H__
  19
  20 /**
  21  * @defgroup CAPI_PANEL_MODULE Panel
  22  * @brief The Panel module provides APIs to choose data or apps easily.
  23  * @ingroup CAPI_APPLICATION_FRAMEWORK
  24  *
  25  * @section CAPI_PANEL_MODULE_OVERVIEW Overview
  26  * <table>
  27  * <tr><th>API</th><th>Description</th></tr>
  28  * <tr><td>@ref CAPI_PANEL_ATTACH_MODULE</td><td>Provide functions to attach images, voices, contacts, events and files.</td></tr>
  29  * <tr><td>@ref CAPI_PANEL_STICKER_MODULE</td><td>Provide functions to attach stickers easily.</td></tr>
  30  * <tr><td>@ref CAPI_PANEL_SHARE_MODULE</td><td>Provide functions to share data with apps.</td></tr>
  31  * </table>
  32  *
  33  * @defgroup CAPI_PANEL_ATTACH_MODULE Attach panel
  34  * @brief The Attach Panel provides functions to attach data easily. Users can attach images, take pictures, record voice and select files to attach into the caller app
  35  * @ingroup CAPI_PANEL_MODULE
  36  *
  37  * @section CAPI_PANEL_ATTACH_MODULE_HEADER Required Header
  38  *   \#include <attach_panel.h>
  39  * @section CAPI_PANEL_ATTACH_MODULE_OVERVIEW Overview
  40  * It provides functions for adding an Attach Panel (attach_panel_create()) and deleting it (attach_panel_destroy()) in an app.\n
  41  * It is shown with (attach_panel_show()) and hiden with (attach_panel_hide()).\n
  42  * The results can be returned into the result callback that is set (attach_panel_set_result_cb()) or unset (attach_panel_unset_result_cb()).\n
  43  * Content categories can be added (attach_panel_add_content_category()) or removed (attach_panel_remove_content_category()).\n
  44  *
  45  * @section CAPI_PANEL_ATTACH_MODULE_FEATURE Related Features
  46  * This API is related with the following features:\n
  47  *  - http://tizen.org/feature/camera\n
  48  *  - http://tizen.org/feature/microphone\n
  49  * It is recommended to design feature related codes in your application for reliability.\n
  50  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
  51  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  52  * More details on featuring your application can be found from <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm"><b>Feature Element</b>.</a>
  53  */
  54
  55 #endif