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  * @ingroup CAPI_APPLICATION_FRAMEWORK
  22  * @defgroup CAPI_PANEL_ATTACH_MODULE Attach panel
  23  * @brief Attach panel provides functions to attach images, voices, contacts, events and files. Users can attach images, take pictures, record voice and select files to attach into the caller app
  24  *
  25  * @section CAPI_PANEL_ATTACH_MODULE_HEADER Required Header
  26  *   \#include <attach_panel.h>
  27  *
  28  * @section CAPI_PANEL_ATTACH_MODULE_OVERVIEW Overview
  29  * - It provides functions for adding an attach panel (attach_panel_create()) and deleting it (attach_panel_destroy()) in an app.\n
  30  * - Content categories can be added (attach_panel_add_content_category()) or removed (attach_panel_remove_content_category()).\n
  31  * - Dynamic configurations can be handled with (attach_panel_set_extra_data()). This is used with a content category.
  32  * - Results can be returned into the result callback that is set (attach_panel_set_result_cb()) or unset (attach_panel_unset_result_cb()).\n
  33  * - Events are delivered into the event callback that is set with (attach_panel_set_event_cb()) or unset with (attach_panel_unset_event_cb()).\n
  34  * - The panel can be shown with (attach_panel_show()) and hidden with (attach_panel_hide()).\n
  35  * - You can get the state of the panel with (attach_panel_get_visibility()).\n
  36  *
  37  * @section CAPI_PANEL_ATTACH_MODULE_FEATURE Related Features
  38  * This API is related with the following features:\n
  39  *  - %http://tizen.org/feature/camera\n
  40  *  - %http://tizen.org/feature/microphone\n
  41  *
  42  * It is recommended to design feature related codes in your application for reliability.\n
  43  * 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
  44  * 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
  45  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>Feature Element</b>.</a>
  46  */
  47
  48
  49 #endif