X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=doc%2Fdali-toolkit-doc.h;h=b2bd7466fffd4cfa88e12df2462374703e70d152;hp=2cb0f1ad80474974d03941a57f32e664886e82d5;hb=938ea2d2a1a42930cf12c743d839aded892949ea;hpb=dcf0eeebe1e683b311b675e93adcc21a0602e671 diff --git a/doc/dali-toolkit-doc.h b/doc/dali-toolkit-doc.h index 2cb0f1a..b2bd746 100644 --- a/doc/dali-toolkit-doc.h +++ b/doc/dali-toolkit-doc.h @@ -1,6 +1,23 @@ #ifndef __DALI_TOOLKIT_DOC_H__ #define __DALI_TOOLKIT_DOC_H__ +/* + * Copyright (c) 2016 Samsung Electronics Co., Ltd. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + /** * @defgroup dali DALi * @ingroup CAPI_UI_FRAMEWORK @@ -8,65 +25,178 @@ * @brief DALi is a cross-platform 3D UI Toolkit for embedded systems. * * @section dali-overview Overview + * * DALi's 3D user interface engine enables you to create rich and high-performance * UI applications. DALi is based on OpenGL ES 2.0, but provides a clean * cross-platform C++ framework. * This means that you can use high-level DALi APIs instead of accessing * low-level OpenGL APIs directly. - * * - * @defgroup dali-toolkit DALi Toolkit - * @ingroup dali + * DALi consists of the following modules: + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
ModuleDescription
@ref dali_coreDALi Core provides core functionalities such as scene graph-based rendering, animation, and event handling.
@ref dali_adaptorDALi Adaptor is a platform adaptation layer.
@ref dali_toolkitDALi Toolkit provides UI components and various effects on top of the DALi Core.
+ * + * The layer diagram for DALi modules is shown below: + * @image html dali-modules.png "Figure: DALi modules" + * + * @defgroup dali_toolkit DALi Toolkit + * + * @brief DALi Toolkit provides UI components and various effects on top of the DALi Core. + * + * @section dali_core_overview Overview + * + * DALi Toolkit consists of the following groups of API: * - * @brief This module provides UI components and various effects on top of the dali-core. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
API GroupDescription
@ref dali_toolkit_controlsControls are interactive components for layouting the user interface.
@ref dali_toolkit_controls_alignmentAlignment is a container which provides an easy way to align other actors inside its boundary.
@ref dali_toolkit_controls_buttonsButton is a small object on UI that you can press.
@ref dali_toolkit_controls_gaussian_blur_viewGaussianBlurView provides a render process that blurs an image.
@ref dali_toolkit_controls_image_viewImageView is a control displying an image.
@ref dali_toolkit_controls_scroll_barScrollBar is a component that can be linked to the scrollable objects.
@ref dali_toolkit_controls_scrollableScrollable contains scrolled controls.
@ref dali_toolkit_controls_item_viewItemView class is a scrollable container that can contain many items.
@ref dali_toolkit_controls_scroll_viewScrollView class provides scrollable view which contains actors and can be scrolled automatically or manually by panning.
@ref dali_toolkit_controls_table_viewTableView class is a layout container for aligning child actors in a grid like layout.
@ref dali_toolkit_controls_text_controlsControls for displaying text or text input.
@ref dali_toolkit_controls_flex_containerFlexContainer is a container for Flexbox layout.
@ref dali_toolkit_controls_video_viewVideoView is a control for video playback and display.
@ref dali_toolkit_controls_sliderSlider is a control to enable sliding an indicator between two values.
@ref dali_toolkit_managersSingleton classes for managing application-wide functionalities.
* + * \ifnot show_tizen_feature + * + * @section dali_toolkit_feature Related Features + * This API is related with the following features:\n + * - http://tizen.org/feature/opengles.version.2_0\n + * + * It is recommended to design feature related codes in your application for reliability.\n + * + * 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 + * + * 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 + * + * More details on featuring your application can be found from Feature Element. + * + * \endif + * + * @ingroup dali * @{ - * @defgroup dali-toolkit-accessibility-manager Accessibility Manager - * @brief AccessibilityManager manages a accessibility focus chain. - - * @defgroup dali-toolkit-controls Controls + * @defgroup dali_toolkit_controls Controls * @brief Controls are interactive components for layouting the user interface. * @{ - * @defgroup dali-toolkit-controls-alignment Alignment + * @defgroup dali_toolkit_controls_alignment Alignment * @brief Alignment is a container which provides an easy way to align other actors inside its boundary. - * @defgroup dali-toolkit-controls-buttons Buttons + * @defgroup dali_toolkit_controls_buttons Buttons * @brief Button is a small object on UI that you can press. - * @defgroup dali-toolkit-controls-gaussian-blur-view Gaussian Blur View + * @defgroup dali_toolkit_controls_gaussian_blur_view Gaussian Blur View * @brief GaussianBlurView provides a render process that blurs an image. - * @defgroup dali-toolkit-controls-image-view Image View + * @defgroup dali_toolkit_controls_image_view Image View * @brief ImageView is a control displying an image. - * @defgroup dali-toolkit-controls-scroll-bar Scroll Bar - * @brief ScrollBar control. + * @defgroup dali_toolkit_controls_scroll_bar Scroll Bar + * @brief ScrollBar is a component that can be linked to the scrollable objects. - * @defgroup dali-toolkit-controls-scrollable Scrollable - * @brief Scrollable container controls. + * @defgroup dali_toolkit_controls_scrollable Scrollable + * @brief Scrollable contains scrolled controls. * @{ - * @defgroup dali-toolkit-controls-item-view Item View + * @defgroup dali_toolkit_controls_item_view Item View * @brief ItemView class is a scrollable container that can contain many items. - * @defgroup dali-toolkit-controls-scroll-view Scroll View - * @brief ScrollView class provides scrollable view which contains actors and can be scrolled automatically or manually by panning. + * @defgroup dali_toolkit_controls_scroll_view Scroll View + * @brief ScrollView class provides scrollable view which contains actors and can be scrolled automatically or manually by panning. * @} - * @defgroup dali-toolkit-controls-table-view Table View + * @defgroup dali_toolkit_controls_table_view Table View * @brief TableView class is a layout container for aligning child actors in a grid like layout. - * @defgroup dali-toolkit-controls-text-controls Text Controls + * @defgroup dali_toolkit_controls_text_controls Text Controls * @brief Controls for displaying text or text input. + * @defgroup dali_toolkit_controls_flex_container Flex Container + * @brief FlexContainer is a container for Flexbox layout. + + * @defgroup dali_toolkit_controls_video_view Video View + * @brief VideoView is a control for video playback and display. + + * @defgroup dali_toolkit_controls_slider Slider + * @brief Slider is a control to enable sliding an indicator between two values. + * @} - * @defgroup dali-toolkit-focus-manager Focus Manager - * @brief Classes for handling keyboard navigation and maintaining the two dimensional keyboard focus chain. + + * @defgroup dali_toolkit_managers Managers + * @brief Singleton classes for managing application-wide functionalities. * @} */