No use the animation when text input popup is pressed.
[platform/core/uifw/dali-toolkit.git] / capi / dali_toolkit_doc.h
1 #ifndef __DALI_TOOLKIT_DOC_H__
2 #define __DALI_TOOLKIT_DOC_H__
3
4 /*
5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
6  *
7  * Licensed under the Apache License, Version 2.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://www.apache.org/licenses/LICENSE-2.0
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 /**
22  * @ingroup CAPI_DALI_FRAMEWORK
23  * @defgroup CAPI_DALI_TOOLKIT_MODULE Dali Toolkit
24  * @brief A library to provide a user interface toolkit on top of Dali.
25  * @section CAPI_DALI_TOOLKIT_MODULE_HEADER Required Header
26  *  \#include <dali-toolkit/dali-toolkit.h>
27  * @section CAPI_DALI_TOOLKIT_MODULE_OVERVIEW Overview
28  *   A library to provide a user interface toolkit running on top of Dali.
29  * <table> <tr><th>API</th><th>Description</th></tr>
30  * <tr><td>@ref CAPI_DALI_TOOLKIT_CONTROLS_MODULE</td><td>User interface controls</td></tr>
31  * <tr><td>@ref CAPI_DALI_TOOLKIT_FACTORY_MODULE</td><td>Factory methods for creating controls</td></tr>
32  * <tr><td>@ref CAPI_DALI_TOOLKIT_FOCUS_MANAGER_MODULE</td><td>Classes for managing focus between controls and actors</td></tr>
33  * <tr><td>@ref CAPI_DALI_TOOLKIT_MARKUP_PROCESSOR_MODULE</td><td>Text markup classes</td></tr>
34  * <tr><td>@ref CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULE</td><td>Shader effects classes</td></tr>
35  * </table>
36  */
37
38 /**
39  * @ingroup CAPI_DALI_TOOLKIT_MODULE
40  * @defgroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE Controls
41  * @brief
42  * @section  CAPI_DALI_TOOLKIT_CONTROLS_MODULE_HEADER Required Header
43  *  \#include <dali-toolkit/dali-toolkit.h>
44  * @section  CAPI_DALI_TOOLKIT_CONTROLS_MODULE_OVERVIEW Overview
45  * <table> <tr><th>API</th><th>Description</th></tr>
46  * <tr><td>@ref CAPI_DALI_TOOLKIT_ALIGNMENT_MODULE </td><td>Layout class</td></tr>
47  * <tr><td>@ref CAPI_DALI_TOOLKIT_BUBBLE_EFFECT_MODULE </td><td>Particle emitter</td></tr>
48  * <tr><td>@ref CAPI_DALI_TOOLKIT_BUTTONS_MODULE </td><td>Button</td></tr>
49  * <tr><td>@ref CAPI_DALI_TOOLKIT_CLUSTER_MODULE </td><td>Styles for clusters of actors</td></tr>
50  * <tr><td>@ref CAPI_DALI_TOOLKIT_DEFAULT_CONTROLS_MODULE </td><td>Factory methods for generating controls</td></tr>
51  * <tr><td>@ref CAPI_DALI_TOOLKIT_IMAGE_VIEW_MODULE </td><td>Classes for displaying images</td></tr>
52  * <tr><td>@ref CAPI_DALI_TOOLKIT_POPUP_MODULE </td><td></td>Popup control</tr>
53  * <tr><td>@ref CAPI_DALI_TOOLKIT_SCROLLABLE_MODULE </td><td>Scrollable containers</td></tr>
54  * <tr><td>@ref CAPI_DALI_TOOLKIT_SUPER_BLUR_VIEW_MODULE </td><td>Control to perform blurring on an image</td></tr>
55  * <tr><td>@ref CAPI_DALI_TOOLKIT_TEXT_INPUT_MODULE </td><td>Input control using the virtual keyboard</td></tr>
56  * <tr><td>@ref CAPI_DALI_TOOLKIT_TEXT_VIEW_MODULE </td><td>Control to display text in different styles</td></tr>
57  * <tr><td>@ref Dali::Toolkit::Control </td><td>Control is the base class for all controls.</td></tr>
58  * <tr><td>@ref Dali::Toolkit::ControlImpl </td><td>This is the internal base class for all controls.</td></tr>
59  * </table>
60  */
61
62 /**
63  * @ingroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE
64  * @defgroup CAPI_DALI_TOOLKIT_ALIGNMENT_MODULE Alignment
65  * @brief
66  * @section CAPI_DALI_TOOLKIT_ALIGNMENT_MODULE_HEADER Required Header
67  *  \#include <dali-toolkit/dali-toolkit.h>
68  * @section CAPI_DALI_TOOLKIT_ALIGNMENT_MODULE_OVERVIEW Overview
69  * <table> <tr><th>API</th><th>Description</th></tr>
70  * <tr><td>@ref Dali::Toolkit::Alignment </td><td>Alignment is a container which provides an easy way to align other actors inside its boundary.</td></tr>
71  * </table>
72  */
73
74 /**
75  * @ingroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE
76  * @defgroup CAPI_DALI_TOOLKIT_BUBBLE_EFFECT_MODULE Bubble Effect
77  * @brief
78  * @section  CAPI_DALI_TOOLKIT_BUBBLE_EFFECT_MODULE_HEADER Required Header
79  *  \#include <dali-toolkit/dali-toolkit.h>
80  * @section CAPI_DALI_TOOLKIT_BUBBLE_EFFECT_MODULE_OVERVIEW Overview
81  * <table> <tr><th>API</th><th>Description</th></tr>
82  * <tr><td>@ref Dali::Toolkit::BubbleEmitter </td><td>BubbleEmitter is used to display lots of moving bubbles on the stage.</td></tr>
83  * </table>
84  */
85
86 /**
87  * @ingroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE
88  * @defgroup CAPI_DALI_TOOLKIT_BUTTONS_MODULE Buttons
89  * @brief
90  * @section  CAPI_DALI_TOOLKIT_BUTTONS_MODULE_HEADER Required Header
91  *  \#include <dali-toolkit/dali-toolkit.h>
92  * @section CAPI_DALI_TOOLKIT_BUTTONS_MODULE_OVERVIEW Overview
93  * <table> <tr><th>API</th><th>Description</th></tr>
94  * <tr><td>@ref Dali::Toolkit::Button </td><td>Button is a base class for different kind of buttons.</td></tr>
95  * <tr><td>@ref Dali::Toolkit::PushButton </td><td>A PushButton changes its appearance when is pressed and returns to its original when is released.</td></tr>
96  * </table>
97  */
98
99 /**
100  * @ingroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE
101  * @defgroup CAPI_DALI_TOOLKIT_CLUSTER_MODULE Cluster
102  * @brief
103  * @section CAPI_DALI_TOOLKIT_CLUSTER_MODULE_HEADER Required Header
104  *  \#include <dali-toolkit/dali-toolkit.h>
105  * @section CAPI_DALI_TOOLKIT_CLUSTER_MODULE_OVERVIEW Overview
106  * <table> <tr><th>API</th><th>Description</th></tr>
107  * <tr><td>@ref Dali::Toolkit::ClusterStyle </td><td>A ClusterStyle describes the constraints, which are imposed on the child actors in the cluster.</td></tr>
108  * </table>
109  */
110
111 /**
112  * @ingroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE
113  * @defgroup CAPI_DALI_TOOLKIT_DEFAULT_CONTROLS_MODULE Default Controls
114  * @brief
115  * @section CAPI_DALI_TOOLKIT_DEFAULT_CONTROLS_MODULE_HEADER Required Header
116  *  \#include <dali-toolkit/dali-toolkit.h>
117  * @section CAPI_DALI_TOOLKIT_DEFAULT_CONTROLS_MODULE_OVERVIEW Overview
118  * <table> <tr><th>API</th><th>Description</th></tr>
119  * <tr><td> Factory methods </td><td>Dali::Toolkit::CreateSolidColorActor(), Dali::Toolkit::CreatePushButton()</td></tr>
120  * </table>
121  */
122
123 /**
124  * @ingroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE
125  * @defgroup CAPI_DALI_TOOLKIT_IMAGE_VIEW_MODULE Image View
126  * @brief
127  * @section  CAPI_DALI_TOOLKIT_IMAGE_VIEW_MODULE_HEADER Required Header
128  *  \#include <dali-toolkit/dali-toolkit.h>
129  * @section CAPI_DALI_TOOLKIT_IMAGE_VIEW_MODULE_OVERVIEW Overview
130  * <table> <tr><th>API</th><th>Description</th></tr>
131  * <tr><td>@ref Dali::Toolkit::MaskedImageView </td><td>MaskedImageView displays the result of an image created from a masking operation.</td></tr>
132  * </table>
133  */
134
135 /**
136  * @ingroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE
137  * @defgroup CAPI_DALI_TOOLKIT_POPUP_MODULE Popup
138  * @brief
139  * @section  CAPI_DALI_TOOLKIT_POPUP_MODULE_HEADER Required Header
140  *  \#include <dali-toolkit/dali-toolkit.h>
141  * @section CAPI_DALI_TOOLKIT_POPUP_MODULE_OVERVIEW Overview
142  * <table> <tr><th>API</th><th>Description</th></tr>
143  * <tr><td>@ref Dali::Toolkit::Popup </td><td>Popup contains content that can come into focus when activated, and out of focus when deactivated.</td></tr>
144  * </table>
145  */
146
147 /**
148  * @ingroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE
149  * @defgroup CAPI_DALI_TOOLKIT_SCROLLABLE_MODULE Scrollable
150  * @brief
151  * @section  CAPI_DALI_TOOLKIT_SCROLLABLE_MODULE_HEADER Required Header
152  *  \#include <dali-toolkit/dali-toolkit.h>
153  * @section CAPI_DALI_TOOLKIT_SCROLLABLE_MODULE_OVERVIEW Overview
154  * <table> <tr><th>API</th><th>Description</th></tr>
155  * (via touch) or automatically. </td></tr>
156  * <tr><td>@ref CAPI_DALI_TOOLKIT_ITEM_VIEW_MODULE</td><td> Item view </td></tr>
157  * <tr><td>@ref CAPI_DALI_TOOLKIT_SCROLL_VIEW_MODULE</td><td> Scroll view </td></tr>
158  * <tr><td>@ref CAPI_DALI_TOOLKIT_SCROLL_CONNECTOR_MODULE</td><td> Scroll Connector </td></tr>
159  * <tr><td>@ref Dali::Toolkit::Scrollable </td><td>Base class for derived Scrollables that contains actors that can be scrolled manually
160  * </table>
161  */
162
163 /**
164  * @ingroup CAPI_DALI_TOOLKIT_SCROLLABLE_MODULE
165  * @defgroup CAPI_DALI_TOOLKIT_ITEM_VIEW_MODULE   Item view
166  * @brief
167  * @section  CAPI_DALI_TOOLKIT_ITEM_VIEW_MODULE_HEADER Required Header
168  *  \#include <dali-toolkit/dali-toolkit.h>
169  * @section CAPI_DALI_TOOLKIT_ITEM_VIEW_MODULE_OVERVIEW Overview
170  * <table> <tr><th>API</th><th>Description</th></tr>
171  * <tr><td>@ref Dali::Toolkit::GridLayout </td><td>An ItemView layout which arranges items in a grid.</td></tr>
172  * <tr><td>@ref Dali::Toolkit::ItemFactory </td><td>ItemFactory is an abstract interface for providing actors to ItemView.</td></tr>
173  * <tr><td>@ref Dali::Toolkit::ItemRange </td><td>A support class for managing ranges of items.</td></tr>
174  * <tr><td>@ref Dali::Toolkit::ItemLayout </td><td>An ItemLayout describes the constraints which are imposed on items in the layout.</td></tr>
175  * <tr><td>@ref Dali::Toolkit::ItemView </td><td>ItemView is a scrollable layout container.</td></tr>
176  * </table>
177  */
178
179 /**
180  * @ingroup CAPI_DALI_TOOLKIT_SCROLLABLE_MODULE
181  * @defgroup CAPI_DALI_TOOLKIT_SCROLL_CONNECTOR_MODULE   Scroll Connector
182  * @brief
183  * @section  CAPI_DALI_TOOLKIT_SCROLL_CONNECTOR_MODULE_HEADER Required Header
184  *  \#include <dali-toolkit/dali-toolkit.h>
185  * @section CAPI_DALI_TOOLKIT_SCROLL_CONNECTOR_MODULE_OVERVIEW Overview
186  * <table> <tr><th>API</th><th>Description</th></tr>
187  * <tr><td>@ref Dali::Toolkit::ScrollConnector </td><td>ScrollConnector is used to connect scrollable containers with components such as scroll bars, indicators etc.</td></tr>
188  * </table>
189  */
190
191 /**
192  * @ingroup CAPI_DALI_TOOLKIT_SCROLLABLE_MODULE
193  * @defgroup CAPI_DALI_TOOLKIT_SCROLL_VIEW_MODULE Scroll view
194  * @brief
195  * @section  CAPI_DALI_TOOLKIT_SCROLL_VIEW_MODULE_HEADER Required Header
196  *  \#include <dali-toolkit/dali-toolkit.h>
197  * @section CAPI_DALI_TOOLKIT_SCROLL_VIEW_MODULE_OVERVIEW Overview
198  * <table> <tr><th>API</th><th>Description</th></tr>
199  * <tr><td>@ref Dali::Toolkit::ScrollViewCubeEffect </td><td>This effect causes Actors to appear to rotate around a 3D cube.</td></tr>
200  * <tr><td>@ref Dali::Toolkit::ScrollViewCustomEffect </td><td>This class has many transition effects for use when scrolling pages, e.g opacity, rotation, swing, translation.</td></tr>
201  * <tr><td>@ref Dali::Toolkit::ScrollViewEffect </td><td>ScrollView Effect base class, used to apply custom effects to a ScrollView instance.</td></tr>
202  * <tr><td>@ref Dali::Toolkit::ScrollViewPageSpiralEffect </td><td>This effect cause each page in a scroll-view to move along a spiral.</td></tr>
203  * <tr><td>@ref Dali::Toolkit::ScrollViewSlideEffect </td><td>ScrollView effect that uses slides for transitioning pages.</td></tr>
204  * <tr><td>@ref Dali::Toolkit::ScrollViewTwistEffect </td><td>ScrollView effect that twists pages onto screen when transitioning.</td></tr>
205  * <tr><td>@ref Dali::Toolkit::RulerDomain </td><td>Used for specifying minimum/maximum extents of a ruler.</td></tr>
206  * <tr><td>@ref Dali::Toolkit::Ruler </td><td>Abstract class to define scroll axes.</td></tr>
207  * <tr><td>@ref Dali::Toolkit::DefaultRuler </td><td>Concrete implementation of Dali::Toolkit::Ruler that has no snapping and has one single page.</td></tr>
208  * <tr><td>@ref Dali::Toolkit::FixedRuler </td><td>Concrete implementation of Ruler that has fixed snapping.</td></tr>
209  * <tr><td>@ref Dali::Toolkit::ScrollView </td><td>ScrollView contains actors that can be scrolled manually (via touch) or automatically.</td></tr>
210  * </table>
211  */
212
213 /**
214  * @ingroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE
215  * @defgroup CAPI_DALI_TOOLKIT_SUPER_BLUR_VIEW_MODULE Super Blur View
216  * @brief
217  * @section  CAPI_DALI_TOOLKIT_SUPER_BLUR_VIEW_MODULE_HEADER Required Header
218  *  \#include <dali-toolkit/dali-toolkit.h>
219  * @section CAPI_DALI_TOOLKIT_SUPER_BLUR_VIEW_MODULE_OVERVIEW Overview
220  * <table> <tr><th>API</th><th>Description</th></tr>
221  * <tr><td>@ref Dali::Toolkit::SuperBlurView </td><td>SuperBlurView accepts an image as input, and displays/animates it with various blur strengths.</td></tr>
222  * </table>
223  */
224
225 /**
226  * @ingroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE
227  * @defgroup CAPI_DALI_TOOLKIT_TEXT_INPUT_MODULE Text Input
228  * @brief
229  * @section  CAPI_DALI_TOOLKIT_TEXT_INPUT_MODULE_HEADER Required Header
230  *  \#include <dali-toolkit/dali-toolkit.h>
231  * @section CAPI_DALI_TOOLKIT_TEXT_INPUT_MODULE_OVERVIEW Overview
232  * <table> <tr><th>API</th><th>Description</th></tr>
233  * <tr><td>@ref Dali::Toolkit::TextInput </td><td>TextInput Actor takes input one character at a time and displays it as a string within an input box.</td></tr>
234  * </table>
235  */
236
237 /**
238  * @ingroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE
239  * @defgroup CAPI_DALI_TOOLKIT_TEXT_VIEW_MODULE Text view
240  * @brief
241  * @section CAPI_DALI_TOOLKIT_TEXT_VIEW_MODULE_HEADER Required Header
242  *  \#include <dali-toolkit/dali-toolkit.h>
243  * @section CAPI_DALI_TOOLKIT_TEXT_VIEW_MODULE_OVERVIEW Overview
244  * <table> <tr><th>API</th><th>Description</th></tr>
245  * <tr><td>@ref Dali::Toolkit::TextView </td><td>TextView is a layout container for text with alignment, multi-line wrapping and formatting support.</td></tr>
246  * </table>
247  */
248
249 /**
250  * @ingroup CAPI_DALI_TOOLKIT_MODULE
251  * @defgroup CAPI_DALI_TOOLKIT_FACTORY_MODULE Factory
252  * @brief
253  * @section CAPI_DALI_TOOLKIT_FACTORY_MODULE_HEADER Required Header
254  *  \#include <dali-toolkit/dali-toolkit.h>
255  * @section CAPI_DALI_TOOLKIT_FACTORY_MODULE_OVERVIEW Overview
256  * <table> <tr><th>API</th><th>Description</th></tr>
257  * <tr><td>@ref Dali::Toolkit::LocalizedControlFactory </td><td>This class provides functionality for creating controls which have localized text.</td></tr>
258  * </table>
259  */
260
261 /**
262  * @ingroup CAPI_DALI_TOOLKIT_MODULE
263  * @defgroup CAPI_DALI_TOOLKIT_FOCUS_MANAGER_MODULE Focus Manager
264  * @brief
265  * @section  CAPI_DALI_TOOLKIT_FOCUS_MANAGER_HEADER Required Header
266  *  \#include <dali-toolkit/dali-toolkit.h>
267  * @section CAPI_DALI_TOOLKIT_FOCUS_MANAGER_MODULE_OVERVIEW Overview
268  * <table> <tr><th>API</th><th>Description</th></tr>
269  * <tr><td>@ref Dali::Toolkit::FocusManager </td><td>Manages registration of actors in a focus chain and changing the focused
270  * actor within that chain.</td></tr>
271  * <tr><td>@ref Dali::Toolkit::KeyboardFocusManager </td><td>Provides the functionality of handling keyboard navigation and maintaining the two dimensional keyboard focus chain.</td></tr>
272  * </table>
273  */
274
275 /**
276  * @ingroup CAPI_DALI_TOOLKIT_MODULE
277  * @defgroup CAPI_DALI_TOOLKIT_MARKUP_PROCESSOR_MODULE Markup Processor
278  * @brief
279  * @section CAPI_DALI_TOOLKIT_MARKUP_PROCESSOR_MODULE_HEADER Required Header
280  *  \#include <dali-toolkit/dali-toolkit.h>
281  * @section CAPI_DALI_TOOLKIT_MARKUP_PROCESSOR_MODULE_OVERVIEW Overview
282  * <table> <tr><th>API</th><th>Description</th></tr>
283  * <tr><td>@ref Dali::Toolkit::MarkupProcessor::StyledText </td><td>A pair of Dali::Text and Dali::TextStyle.</td></tr>
284  * <tr><td>@ref Dali::Toolkit::MarkupProcessor::StyledTextArray </td><td> Vector of StyledText </td></tr>
285  * <tr><td>@ref Dali::Toolkit::MarkupProcessor </td><td>
286 Dali::Toolkit::MarkupProcessor::GetStyledTextArray()
287 Dali::Toolkit::MarkupProcessor::GetPlainString()
288 Dali::Toolkit::MarkupProcessor::GetMarkupString()
289 Dali::Toolkit::MarkupProcessor::SetTextStyle()
290 Dali::Toolkit::MarkupProcessor::SetTextStyle()
291 Dali::Toolkit::MarkupProcessor::SetTextStyleToRange()
292 </td></tr>
293  * </table>
294  */
295
296 /**
297  * @ingroup CAPI_DALI_TOOLKIT_MODULE
298  * @defgroup CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULE Shader Effects
299  * @brief
300  * @section  CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULE_HEADER Required Header
301  *  \#include <dali-toolkit/dali-toolkit.h>
302  * @section CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULE_OVERVIEW Overview
303  * <table> <tr><th>API</th><th>Description</th></tr>
304  * <tr><td>@ref Dali::Toolkit::DissolveEffect </td><td>DissolveEffect is a custom shader effect to achieve Dissolve effects in Image actors.</td></tr>
305  * <tr><td>@ref Dali::Toolkit::ImageRegionEffect </td><td>ImageRegionEffect is a custom shader effect to show only a region of an Image actor.</td></tr>
306  * <tr><td>@ref Dali::Toolkit::IrisEffect </td><td>IrisEffect is a custom shader effect to achieve iris effects in Image actors.</td></tr>
307  * <tr><td>@ref Dali::Toolkit::MaskEffect </td><td>MaskEffect is used to control which parts of an image are visible, using the alpha channel of a separate mask image.</td></tr>
308  * <tr><td>@ref Dali::Toolkit::NinePatchMaskEffect </td><td>NinePatchMaskEffect is used to control which parts of an image are visible, using the alpha channel of a separate mask image.</td></tr>
309  * <tr><td>@ref Dali::Toolkit::PageTurnBookSpineEffect </td><td>This is an assisting effect of PageTurnEffect to display a book spine on _static_ pages, and also to flip the image horizontally when needed.</td></tr>
310  * <tr><td>@ref Dali::Toolkit::PageTurnEffect </td><td>PageTurnEffect is a custom shader effect to achieve a page turn effect for Image actors.</td></tr>
311  * <tr><td>@ref Dali::Toolkit::RippleEffect </td><td>RippleEffect is a custom shader effect to achieve ripple effects on Image actors</td></tr>
312  * <tr><td>@ref Dali::Toolkit::Ripple2DEffect </td><td>Ripple2DEffect is a custom shader effect to achieve 2d ripple effects on Image actors</td></tr>
313  * <tr><td>@ref Dali::Toolkit::SwirlEffect </td><td>SwirlEffect is a custom shader effect to achieve swirl effects in Image actors.</td></tr>
314  * </table>
315  */
316
317
318 #endif //__DALI_TOOLKIT_DOC_H__