Merge "Add descriptions and example codes" into devel/master
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / text-scroller-interface.h
1 #ifndef __DALI_TOOLKIT_TEXT_SCROLLER_INTERFACE_H__
2 #define __DALI_TOOLKIT_TEXT_SCROLLER_INTERFACE_H__
3
4 /*
5  * Copyright (c) 2016 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 namespace Dali
22 {
23
24 class Actor;
25
26 namespace Toolkit
27 {
28
29 namespace Text
30 {
31
32 /**
33  * @brief An interface used by the text-controls which implement auto-scrolling
34  */
35 class ScrollerInterface
36 {
37 public:
38
39   /**
40    * @brief Constructor.
41    */
42   ScrollerInterface();
43
44   /**
45    * @brief Virtual destructor.
46    */
47   virtual ~ScrollerInterface();
48
49   /**
50    * @brief Called when the scrolling finishes
51    */
52   virtual void ScrollingFinished() = 0;
53 };
54
55 } // namespace Text
56
57 } // namespace Toolkit
58
59 } // namespace Dali
60
61 #endif // __DALI_TOOLKIT_TEXT_SCROLLER_INTERFACE_H__