[dali_2.3.20] Merge branch 'devel/master'
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / devel-api / visuals / animated-image-visual-actions-devel.h
1 #ifndef DALI_TOOLKIT_DEVEL_API_VISUALS_ANIMATED_IMAGE_VISUAL_ACTIONS_DEVEL_H
2 #define DALI_TOOLKIT_DEVEL_API_VISUALS_ANIMATED_IMAGE_VISUAL_ACTIONS_DEVEL_H
3
4 /*
5  * Copyright (c) 2023 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 #include <dali-toolkit/devel-api/toolkit-action-index-ranges.h>
21 #include <dali-toolkit/devel-api/visuals/image-visual-actions-devel.h>
22
23 namespace Dali
24 {
25 namespace Toolkit
26 {
27 namespace DevelAnimatedImageVisual
28 {
29 /**
30  * @brief Actions that the animated image visual can perform.  These actions are called through the Visual::Base::DoAction API.
31  */
32 namespace Action
33 {
34 /**
35  * @brief The available actions for this visual
36  */
37 enum Type
38 {
39   PLAY = DevelImageVisual::Action::IMAGE_VISUAL_ACTION_END_INDEX, ///< Play the animated GIF. This is also Default playback mode.
40   PAUSE,                                                          ///< Pause the animated GIF.
41   STOP,                                                           ///< Stop the animated GIF.
42   JUMP_TO,                                                        ///< Jump to the specified frame. Property::INTEGER value should be passed.
43
44   ANIMATED_IMAGE_VISUAL_ACTION_END_INDEX = DevelImageVisual::Action::IMAGE_VISUAL_ACTION_END_INDEX + 1000  ///< End of animated image visual action index.
45 };
46
47 } // namespace Action
48
49 } // namespace DevelAnimatedImageVisual
50
51 } // namespace Toolkit
52
53 } // namespace Dali
54
55 #endif // DALI_TOOLKIT_DEVEL_API_VISUALS_ANIMATED_IMAGE_VISUAL_ACTIONS_DEVEL_H