doc/dali-toolkit-doc.h

   1 #ifndef __DALI_TOOLKIT_DOC_H__
   2 #define __DALI_TOOLKIT_DOC_H__
   3
   4 /**
   5  * @defgroup dali DALi
   6  * @ingroup CAPI_UI_FRAMEWORK
   7  *
   8  * @brief DALi is a cross-platform 3D UI Toolkit for embedded systems.
   9  *
  10  * @section dali-overview Overview
  11  * DALi's 3D user interface engine enables you to create rich and high-performance
  12  * UI applications. DALi is based on OpenGL ES 2.0, but provides a clean
  13  * cross-platform C++ framework.
  14  * This means that you can use high-level DALi APIs instead of accessing
  15  * low-level OpenGL APIs directly.
  16  * <ul>
  17  * <li>DALi Core: This module provides scene graph-based rendering, animation, and event handling.</li>
  18  * <li>DALi Adaptor: This module is a platform adaptation layer.</li>
  19  * <li>DALi Toolkit: This module provides UI components and various effects on top of the DALi Core.</li>
  20  * </ul>
  21  *
  22  * @defgroup dali_toolkit DALi Toolkit
  23  * @ingroup dali
  24  *
  25  * @brief This module provides UI components and various effects on top of the DALi Core.
  26  *
  27  * @{
  28  *   @defgroup dali_toolkit_accessibility_manager Accessibility Manager
  29  *   @brief AccessibilityManager manages a accessibility focus chain.
  30
  31  *   @defgroup dali_toolkit_controls Controls
  32  *   @brief Controls are interactive components for layouting the user interface.
  33
  34  *   @{
  35  *     @defgroup dali_toolkit_controls_alignment Alignment
  36  *     @brief Alignment is a container which provides an easy way to align other actors inside its boundary.
  37
  38  *     @defgroup dali_toolkit_controls_buttons Buttons
  39  *     @brief Button is a small object on UI that you can press.
  40
  41  *     @defgroup dali_toolkit_controls_gaussian_blur_view Gaussian Blur View
  42  *     @brief GaussianBlurView provides a render process that blurs an image.
  43
  44  *     @defgroup dali_toolkit_controls_image_view Image View
  45  *     @brief ImageView is a control displying an image.
  46
  47  *     @defgroup dali_toolkit_controls_scroll_bar Scroll Bar
  48  *     @brief ScrollBar control.
  49
  50  *     @defgroup dali_toolkit_controls_scrollable Scrollable
  51  *     @brief Scrollable container controls.
  52
  53  *     @{
  54  *       @defgroup dali_toolkit_controls_item_view Item View
  55  *       @brief ItemView class is a scrollable container that can contain many items.
  56
  57  *       @defgroup dali_toolkit_controls_scroll_view Scroll View
  58  *       @brief ScrollView class provides scrollable view which contains actors and can be scrolled automatically or manually by panning.
  59
  60  *     @}
  61  *     @defgroup dali_toolkit_controls_table_view Table View
  62  *     @brief TableView class is a layout container for aligning child actors in a grid like layout.
  63
  64  *     @defgroup dali_toolkit_controls_text_controls Text Controls
  65  *     @brief Controls for displaying text or text input.
  66
  67  *   @}
  68  *   @defgroup dali_toolkit_focus_manager Focus Manager
  69  *   @brief Classes for handling keyboard navigation and maintaining the two dimensional keyboard focus chain.
  70
  71  * @}
  72  */
  73
  74
  75 #endif  /* __DALI_TOOLKIT_DOC_H__ */