capi/dali-adaptor-doc.h

   1 #ifndef __DALI_DOC_H__
   2 #define __DALI_DOC_H__
   3
   4 //
   5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6 //
   7 // Licensed under the Flora License, Version 1.0 (the License);
   8 // you may not use this file except in compliance with the License.
   9 // You may obtain a copy of the License at
  10 //
  11 //     http://floralicense.org/license/
  12 //
  13 // Unless required by applicable law or agreed to in writing, software
  14 // distributed under the License is distributed on an AS IS BASIS,
  15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 // See the License for the specific language governing permissions and
  17 // limitations under the License.
  18 //
  19
  20 /**
  21  * @ingroup CAPI_DALI_MODULE
  22  * @defgroup CAPI_DALI_ADAPTOR_MODULE Adaptor Framework
  23  * @section CAPI_DALI_ADAPTOR_MODULE_HEADER Required Header
  24  * \#include <dali/dali.h>
  25  * @section CAPI_DALI_ADAPTOR_MODULE_OVERVIEW Overview
  26  * The adaptor framework provides interfaces onto the platform for Dali.
  27  * <table> <tr><th>API</th><th>Description</th></tr>
  28  * <tr><td>@ref Dali::EvasPlugin </td><td>Used by EFL applications that wish to use Dali.</td></tr>
  29  * <tr><td>@ref Dali::NativeBufferPlugin </td><td>Used by Tizen applications that wish to capture Dali output in a buffer.</td></tr>
  30  * <tr><td>@ref Dali::AccessibilityManager </td><td>Provides signals for accessibility and screen reader.</td></tr>
  31  * <tr><td>@ref Dali::Adaptor </td><td>An Adaptor object is used to initialize and control how Dali runs.</td></tr>
  32  * <tr><td>@ref Dali::ClipboardEventNotifier </td><td>Provides signals when clipboard events are received from the device.</td></tr>
  33  * <tr><td>@ref Dali::Clipboard </td><td>Interface to the device's clipboard.</td></tr>
  34  * <tr><td>@ref Dali::DeviceLayout </td><td> The attributes of the screen on the device.</td></tr>
  35  * <tr><td>@ref Dali::DragAndDropDetector </td><td>The DragAndDropDetector s provides signals when draggable objects are dragged into the Dali window.</td></tr>
  36  * <tr><td>@ref Dali::HapticPlayer </td><td></td>Plays haptic effects.</tr>
  37  * <tr><td>@ref Dali::ImfManager </td><td>Interface to the device's Input framework.</td></tr>
  38  * <tr><td>@ref Dali::Orientation </td><td>Determines the device orientation.</td></tr>
  39  * <tr><td>@ref Dali::PixmapImage </td><td>Used for displaying native Pixmap images.</td></tr>
  40  * <tr><td>@ref Dali::RenderSurface </td><td>Interface for a render surface onto which Dali draws.</td></tr>
  41  * <tr><td>@ref Dali::SoundPlayer </td><td>Class for playing sound effects.</td></tr>
  42  * <tr><td>@ref Dali::StyleChange </td><td>Class for describing what style information has changed.</td></tr>
  43  * <tr><td>@ref Dali::StyleMonitor </td><td>Monitors the platform for style changes.</td></tr>
  44  * <tr><td>@ref Dali::Timer </td><td>Mechanism to issue simple periodic or one-shot events.</td></tr>
  45  * <tr><td>@ref Dali::TtsPlayer </td><td>Interface to the Text-to-Speech player.</td></tr>
  46  * <tr><td>@ref Dali::VirtualKeyboard </td><td>Interface to the virtual keyboard.</td></tr>
  47  * <tr><td>@ref Dali::Window </td><td>The Window class is used for drawing Dali.</td></tr>
  48  * </table>
  49  */