Conversion to Apache 2.0 license
[platform/core/uifw/dali-toolkit.git] / base / dali-toolkit / internal / controls / text-view / split-by-new-line-char-policies.h
1 #ifndef __DALI_TOOLKIT_INTERNAL_SPLIT_BY_NEW_LINE_CHAR_POLICIES_H__
2 #define __DALI_TOOLKIT_INTERNAL_SPLIT_BY_NEW_LINE_CHAR_POLICIES_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 // INTERNAL INCLUDES
22 #include "text-view-impl.h"
23 #include "text-view-processor-types.h"
24
25 namespace Dali
26 {
27
28 namespace Toolkit
29 {
30
31 namespace Internal
32 {
33
34 namespace SplitByNewLineChar
35 {
36
37 /**
38  * Sets text-actor's size and position accordingly with the given text-view's size and layout parameters.
39  * Visible text-actors are added to the text-view. Non visible actors are not added.
40  *
41  * @param[in] textView The handle to the text-view actor.
42  * @param[in] relayoutOperationMask Mask which defines which operations need to be done in the relayout process.
43  * @param[in] layoutParameters The layout parameters.
44  * @param[in] visualParameters Some visual parameters (fade, sort modifier and blending).
45  * @param[in] relayoutData The text-view's data structures which are modified by this function.
46  */
47 void Relayout( Actor textView,
48                TextView::RelayoutOperationMask relayoutOperationMask,
49                const TextView::LayoutParameters& layoutParameters,
50                const TextView::VisualParameters& visualParameters,
51                TextView::RelayoutData& relayoutData );
52
53 } // namespace SplitByNewLineChar
54
55 } // namespace Internal
56
57 } // namespace Toolkit
58
59 } // namespace Dali
60
61 #endif // __DALI_TOOLKIT_INTERNAL_SPLIT_BY_NEW_LINE_CHAR_POLICIES_H__