#ifndef DALI_TOOLKIT_DOC_H #define DALI_TOOLKIT_DOC_H /* * Copyright (c) 2019 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 * * @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. * * 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_toolkit_overview Overview * * DALi Toolkit consists of the following groups of API: * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
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 displaying an image.
@ref dali_toolkit_controls_model3d_viewModel3dView is a control for displaying 3d geometry.
@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_controls_progress_barProgressBar is a control to give the user an indication of the progress of an operation.
@ref dali_toolkit_managersSingleton classes for managing application-wide functionalities.
@ref dali_toolkit_visualsVisuals can control rendering the contents as using Property.
@ref dali_toolkit_image_loaderThe ImageLoader is used to load pixel data from a URL.
* * \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_controls Controls * @brief Controls are interactive components for layouting the user interface. * @{ * @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 * @brief Button is a small object on UI that you can press. * @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 * @brief ImageView is a control displaying an image. * @defgroup dali_toolkit_controls_model3d_view Model3dView * @brief Model3dView is a control for displaying 3d geometry. * @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 contains scrolled controls. * @{ * @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_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 * @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_controls_progress_bar Progress Bar * @brief ProgressBar is a control to give the user an indication of the progress of an operation. * @} * @defgroup dali_toolkit_managers Managers * @brief Singleton classes for managing application-wide functionalities. * @defgroup dali_toolkit_visuals Visuals * @brief Visuals can control rendering the contents as using Property. * @defgroup dali_toolkit_image_loader Image Loader * @brief The ImageLoader is used to load pixel data from a URL. * @} */ #endif // DALI_TOOLKIT_DOC_H