#ifndef __DALI_TOOLKIT_DOC_H__ #define __DALI_TOOLKIT_DOC_H__ // // Copyright (c) 2014 Samsung Electronics Co., Ltd. // // Licensed under the Flora License, Version 1.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://floralicense.org/license/ // // 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. // /** * @ingroup CAPI_DALI_FRAMEWORK * @defgroup CAPI_DALI_TOOLKIT_MODULE Dali Toolkit * @brief A library to provide a user interface toolkit on top of Dali. * @section CAPI_DALI_TOOLKIT_MODULE_HEADER Required Header * \#include * @section CAPI_DALI_TOOLKIT_MODULE_OVERVIEW Overview * A library to provide a user interface toolkit running on top of Dali. * * * * * * *
APIDescription
@ref CAPI_DALI_TOOLKIT_CONTROLS_MODULEUser interface controls
@ref CAPI_DALI_TOOLKIT_FACTORY_MODULEFactory methods for creating controls
@ref CAPI_DALI_TOOLKIT_FOCUS_MANAGER_MODULEClasses for managing focus between controls and actors
@ref CAPI_DALI_TOOLKIT_MARKUP_PROCESSOR_MODULEText markup classes
@ref CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULEShader effects classes
*/ /** * @ingroup CAPI_DALI_TOOLKIT_MODULE * @defgroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE Controls * @brief * @section CAPI_DALI_TOOLKIT_CONTROLS_MODULE_HEADER Required Header * \#include * @section CAPI_DALI_TOOLKIT_CONTROLS_MODULE_OVERVIEW Overview * * * * * * * * Popup control * * * * * * *
APIDescription
@ref CAPI_DALI_TOOLKIT_ALIGNMENT_MODULE Layout class
@ref CAPI_DALI_TOOLKIT_BUBBLE_EFFECT_MODULE Particle emitter
@ref CAPI_DALI_TOOLKIT_BUTTONS_MODULE Button
@ref CAPI_DALI_TOOLKIT_CLUSTER_MODULE Styles for clusters of actors
@ref CAPI_DALI_TOOLKIT_DEFAULT_CONTROLS_MODULE Factory methods for generating controls
@ref CAPI_DALI_TOOLKIT_IMAGE_VIEW_MODULE Classes for displaying images
@ref CAPI_DALI_TOOLKIT_POPUP_MODULE
@ref CAPI_DALI_TOOLKIT_SCROLLABLE_MODULE Scrollable containers
@ref CAPI_DALI_TOOLKIT_SUPER_BLUR_VIEW_MODULE Control to perform blurring on an image
@ref CAPI_DALI_TOOLKIT_TEXT_INPUT_MODULE Input control using the virtual keyboard
@ref CAPI_DALI_TOOLKIT_TEXT_VIEW_MODULE Control to display text in different styles
@ref Dali::Toolkit::Control Control is the base class for all controls.
@ref Dali::Toolkit::ControlImpl This is the internal base class for all controls.
*/ /** * @ingroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE * @defgroup CAPI_DALI_TOOLKIT_ALIGNMENT_MODULE Alignment * @brief * @section CAPI_DALI_TOOLKIT_ALIGNMENT_MODULE_HEADER Required Header * \#include * @section CAPI_DALI_TOOLKIT_ALIGNMENT_MODULE_OVERVIEW Overview * * *
APIDescription
@ref Dali::Toolkit::Alignment Alignment is a container which provides an easy way to align other actors inside its boundary.
*/ /** * @ingroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE * @defgroup CAPI_DALI_TOOLKIT_BUBBLE_EFFECT_MODULE Bubble Effect * @brief * @section CAPI_DALI_TOOLKIT_BUBBLE_EFFECT_MODULE_HEADER Required Header * \#include * @section CAPI_DALI_TOOLKIT_BUBBLE_EFFECT_MODULE_OVERVIEW Overview * * *
APIDescription
@ref Dali::Toolkit::BubbleEmitter BubbleEmitter is used to display lots of moving bubbles on the stage.
*/ /** * @ingroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE * @defgroup CAPI_DALI_TOOLKIT_BUTTONS_MODULE Buttons * @brief * @section CAPI_DALI_TOOLKIT_BUTTONS_MODULE_HEADER Required Header * \#include * @section CAPI_DALI_TOOLKIT_BUTTONS_MODULE_OVERVIEW Overview * * * *
APIDescription
@ref Dali::Toolkit::Button Button is a base class for different kind of buttons.
@ref Dali::Toolkit::PushButton A PushButton changes its appearance when is pressed and returns to its original when is released.
*/ /** * @ingroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE * @defgroup CAPI_DALI_TOOLKIT_CLUSTER_MODULE Cluster * @brief * @section CAPI_DALI_TOOLKIT_CLUSTER_MODULE_HEADER Required Header * \#include * @section CAPI_DALI_TOOLKIT_CLUSTER_MODULE_OVERVIEW Overview * * *
APIDescription
@ref Dali::Toolkit::ClusterStyle A ClusterStyle describes the constraints, which are imposed on the child actors in the cluster.
*/ /** * @ingroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE * @defgroup CAPI_DALI_TOOLKIT_DEFAULT_CONTROLS_MODULE Default Controls * @brief * @section CAPI_DALI_TOOLKIT_DEFAULT_CONTROLS_MODULE_HEADER Required Header * \#include * @section CAPI_DALI_TOOLKIT_DEFAULT_CONTROLS_MODULE_OVERVIEW Overview * * *
APIDescription
Factory methods Dali::Toolkit::CreateSolidColorActor(), Dali::Toolkit::CreatePushButton()
*/ /** * @ingroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE * @defgroup CAPI_DALI_TOOLKIT_IMAGE_VIEW_MODULE Image View * @brief * @section CAPI_DALI_TOOLKIT_IMAGE_VIEW_MODULE_HEADER Required Header * \#include * @section CAPI_DALI_TOOLKIT_IMAGE_VIEW_MODULE_OVERVIEW Overview * * *
APIDescription
@ref Dali::Toolkit::MaskedImageView MaskedImageView displays the result of an image created from a masking operation.
*/ /** * @ingroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE * @defgroup CAPI_DALI_TOOLKIT_POPUP_MODULE Popup * @brief * @section CAPI_DALI_TOOLKIT_POPUP_MODULE_HEADER Required Header * \#include * @section CAPI_DALI_TOOLKIT_POPUP_MODULE_OVERVIEW Overview * * *
APIDescription
@ref Dali::Toolkit::Popup Popup contains content that can come into focus when activated, and out of focus when deactivated.
*/ /** * @ingroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE * @defgroup CAPI_DALI_TOOLKIT_SCROLLABLE_MODULE Scrollable * @brief * @section CAPI_DALI_TOOLKIT_SCROLLABLE_MODULE_HEADER Required Header * \#include * @section CAPI_DALI_TOOLKIT_SCROLLABLE_MODULE_OVERVIEW Overview * * (via touch) or automatically. * * * *
APIDescription
@ref CAPI_DALI_TOOLKIT_ITEM_VIEW_MODULE Item view
@ref CAPI_DALI_TOOLKIT_SCROLL_VIEW_MODULE Scroll view
@ref CAPI_DALI_TOOLKIT_SCROLL_CONNECTOR_MODULE Scroll Connector
@ref Dali::Toolkit::Scrollable Base class for derived Scrollables that contains actors that can be scrolled manually *
*/ /** * @ingroup CAPI_DALI_TOOLKIT_SCROLLABLE_MODULE * @defgroup CAPI_DALI_TOOLKIT_ITEM_VIEW_MODULE Item view * @brief * @section CAPI_DALI_TOOLKIT_ITEM_VIEW_MODULE_HEADER Required Header * \#include * @section CAPI_DALI_TOOLKIT_ITEM_VIEW_MODULE_OVERVIEW Overview * * * * * * *
APIDescription
@ref Dali::Toolkit::GridLayout An ItemView layout which arranges items in a grid.
@ref Dali::Toolkit::ItemFactory ItemFactory is an abstract interface for providing actors to ItemView.
@ref Dali::Toolkit::ItemRange A support class for managing ranges of items.
@ref Dali::Toolkit::ItemLayout An ItemLayout describes the constraints which are imposed on items in the layout.
@ref Dali::Toolkit::ItemView ItemView is a scrollable layout container.
*/ /** * @ingroup CAPI_DALI_TOOLKIT_SCROLLABLE_MODULE * @defgroup CAPI_DALI_TOOLKIT_SCROLL_CONNECTOR_MODULE Scroll Connector * @brief * @section CAPI_DALI_TOOLKIT_SCROLL_CONNECTOR_MODULE_HEADER Required Header * \#include * @section CAPI_DALI_TOOLKIT_SCROLL_CONNECTOR_MODULE_OVERVIEW Overview * * *
APIDescription
@ref Dali::Toolkit::ScrollConnector ScrollConnector is used to connect scrollable containers with components such as scroll bars, indicators etc.
*/ /** * @ingroup CAPI_DALI_TOOLKIT_SCROLLABLE_MODULE * @defgroup CAPI_DALI_TOOLKIT_SCROLL_VIEW_MODULE Scroll view * @brief * @section CAPI_DALI_TOOLKIT_SCROLL_VIEW_MODULE_HEADER Required Header * \#include * @section CAPI_DALI_TOOLKIT_SCROLL_VIEW_MODULE_OVERVIEW Overview * * * * * * * * * * * * *
APIDescription
@ref Dali::Toolkit::ScrollViewCubeEffect This effect causes Actors to appear to rotate around a 3D cube.
@ref Dali::Toolkit::ScrollViewCustomEffect This class has many transition effects for use when scrolling pages, e.g opacity, rotation, swing, translation.
@ref Dali::Toolkit::ScrollViewEffect ScrollView Effect base class, used to apply custom effects to a ScrollView instance.
@ref Dali::Toolkit::ScrollViewPageSpiralEffect This effect cause each page in a scroll-view to move along a spiral.
@ref Dali::Toolkit::ScrollViewSlideEffect ScrollView effect that uses slides for transitioning pages.
@ref Dali::Toolkit::ScrollViewTwistEffect ScrollView effect that twists pages onto screen when transitioning.
@ref Dali::Toolkit::RulerDomain Used for specifying minimum/maximum extents of a ruler.
@ref Dali::Toolkit::Ruler Abstract class to define scroll axes.
@ref Dali::Toolkit::DefaultRuler Concrete implementation of Dali::Toolkit::Ruler that has no snapping and has one single page.
@ref Dali::Toolkit::FixedRuler Concrete implementation of Ruler that has fixed snapping.
@ref Dali::Toolkit::ScrollView ScrollView contains actors that can be scrolled manually (via touch) or automatically.
*/ /** * @ingroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE * @defgroup CAPI_DALI_TOOLKIT_SUPER_BLUR_VIEW_MODULE Super Blur View * @brief * @section CAPI_DALI_TOOLKIT_SUPER_BLUR_VIEW_MODULE_HEADER Required Header * \#include * @section CAPI_DALI_TOOLKIT_SUPER_BLUR_VIEW_MODULE_OVERVIEW Overview * * *
APIDescription
@ref Dali::Toolkit::SuperBlurView SuperBlurView accepts an image as input, and displays/animates it with various blur strengths.
*/ /** * @ingroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE * @defgroup CAPI_DALI_TOOLKIT_TEXT_INPUT_MODULE Text Input * @brief * @section CAPI_DALI_TOOLKIT_TEXT_INPUT_MODULE_HEADER Required Header * \#include * @section CAPI_DALI_TOOLKIT_TEXT_INPUT_MODULE_OVERVIEW Overview * * *
APIDescription
@ref Dali::Toolkit::TextInput TextInput Actor takes input one character at a time and displays it as a string within an input box.
*/ /** * @ingroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE * @defgroup CAPI_DALI_TOOLKIT_TEXT_VIEW_MODULE Text view * @brief * @section CAPI_DALI_TOOLKIT_TEXT_VIEW_MODULE_HEADER Required Header * \#include * @section CAPI_DALI_TOOLKIT_TEXT_VIEW_MODULE_OVERVIEW Overview * * *
APIDescription
@ref Dali::Toolkit::TextView TextView is a layout container for text with alignment, multi-line wrapping and formatting support.
*/ /** * @ingroup CAPI_DALI_TOOLKIT_MODULE * @defgroup CAPI_DALI_TOOLKIT_FACTORY_MODULE Factory * @brief * @section CAPI_DALI_TOOLKIT_FACTORY_MODULE_HEADER Required Header * \#include * @section CAPI_DALI_TOOLKIT_FACTORY_MODULE_OVERVIEW Overview * * *
APIDescription
@ref Dali::Toolkit::LocalizedControlFactory This class provides functionality for creating controls which have localized text.
*/ /** * @ingroup CAPI_DALI_TOOLKIT_MODULE * @defgroup CAPI_DALI_TOOLKIT_FOCUS_MANAGER_MODULE Focus Manager * @brief * @section CAPI_DALI_TOOLKIT_FOCUS_MANAGER_HEADER Required Header * \#include * @section CAPI_DALI_TOOLKIT_FOCUS_MANAGER_MODULE_OVERVIEW Overview * * * *
APIDescription
@ref Dali::Toolkit::FocusManager Manages registration of actors in a focus chain and changing the focused * actor within that chain.
@ref Dali::Toolkit::KeyboardFocusManager Provides the functionality of handling keyboard navigation and maintaining the two dimensional keyboard focus chain.
*/ /** * @ingroup CAPI_DALI_TOOLKIT_MODULE * @defgroup CAPI_DALI_TOOLKIT_MARKUP_PROCESSOR_MODULE Markup Processor * @brief * @section CAPI_DALI_TOOLKIT_MARKUP_PROCESSOR_MODULE_HEADER Required Header * \#include * @section CAPI_DALI_TOOLKIT_MARKUP_PROCESSOR_MODULE_OVERVIEW Overview * * * * *
APIDescription
@ref Dali::Toolkit::MarkupProcessor::StyledText A pair of Dali::Text and Dali::TextStyle.
@ref Dali::Toolkit::MarkupProcessor::StyledTextArray Vector of StyledText
@ref Dali::Toolkit::MarkupProcessor Dali::Toolkit::MarkupProcessor::GetStyledTextArray() Dali::Toolkit::MarkupProcessor::GetPlainString() Dali::Toolkit::MarkupProcessor::GetMarkupString() Dali::Toolkit::MarkupProcessor::SetTextStyle() Dali::Toolkit::MarkupProcessor::SetTextStyle() Dali::Toolkit::MarkupProcessor::SetTextStyleToRange()
*/ /** * @ingroup CAPI_DALI_TOOLKIT_MODULE * @defgroup CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULE Shader Effects * @brief * @section CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULE_HEADER Required Header * \#include * @section CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULE_OVERVIEW Overview * * * * * * * * * * * *
APIDescription
@ref Dali::Toolkit::DissolveEffect DissolveEffect is a custom shader effect to achieve Dissolve effects in Image actors.
@ref Dali::Toolkit::ImageRegionEffect ImageRegionEffect is a custom shader effect to show only a region of an Image actor.
@ref Dali::Toolkit::IrisEffect IrisEffect is a custom shader effect to achieve iris effects in Image actors.
@ref Dali::Toolkit::MaskEffect MaskEffect is used to control which parts of an image are visible, using the alpha channel of a separate mask image.
@ref Dali::Toolkit::NinePatchMaskEffect NinePatchMaskEffect is used to control which parts of an image are visible, using the alpha channel of a separate mask image.
@ref Dali::Toolkit::PageTurnBookSpineEffect This is an assisting effect of PageTurnEffect to display a book spine on _static_ pages, and also to flip the image horizontally when needed.
@ref Dali::Toolkit::PageTurnEffect PageTurnEffect is a custom shader effect to achieve a page turn effect for Image actors.
@ref Dali::Toolkit::RippleEffect RippleEffect is a custom shader effect to achieve ripple effects on Image actors
@ref Dali::Toolkit::Ripple2DEffect Ripple2DEffect is a custom shader effect to achieve 2d ripple effects on Image actors
@ref Dali::Toolkit::SwirlEffect SwirlEffect is a custom shader effect to achieve swirl effects in Image actors.
*/ #endif //__DALI_TOOLKIT_DOC_H__