[dali_2.0.25] Merge branch 'devel/master'
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / text-controller-relayouter.h
1 #ifndef DALI_TOOLKIT_TEXT_CONTROLLER_RELAYOUTER_H
2 #define DALI_TOOLKIT_TEXT_CONTROLLER_RELAYOUTER_H
3
4 /*
5  * Copyright (c) 2021 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 // EXTERNAL INCLUDES
22 #include <dali/public-api/actors/actor-enumerations.h>
23 #include <dali/public-api/math/vector2.h>
24 #include <dali/public-api/math/vector3.h>
25
26 // INTERNAL INCLUDES
27 #include <dali-toolkit/internal/text/text-controller.h>
28
29 namespace Dali
30 {
31 namespace Toolkit
32 {
33 namespace Text
34 {
35 /**
36  * Contains all the relayouting related methods for Text::Controller
37  */
38 struct Controller::Relayouter
39 {
40   /**
41    * @brief Called by the Controller to retrieve the natural size.
42    *
43    * @param[in] controller A reference to the controller class
44    * @return
45    */
46   static Vector3 GetNaturalSize(Controller& controller);
47
48   /**
49    * @brief Called by the Controller to check if the text fits.
50    *
51    * @param[in] controller A reference to the controller class
52    * @param[in] pointSize The point size
53    * @param[in] layoutSize The layout size
54    * @return
55    */
56   static bool CheckForTextFit(Controller& controller, float pointSize, const Size& layoutSize);
57
58   /**
59    * @brief Calculates the point size for text for given layout()
60    *
61    * @param[in] controller A reference to the controller class
62    * @param[in] layoutSize The layout size
63    */
64   static void FitPointSizeforLayout(Controller& controller, const Size& layoutSize);
65
66   /**
67    * @brief Called by the Controller to get the height for a particular width.
68    *
69    * @param[in] controller A reference to the controller class
70    * @param[in] width The width we want the height for
71    * @return
72    */
73   static float GetHeightForWidth(Controller& controller, float width);
74
75   /**
76    * @brief Called by the Controller to do the relayout itself.
77    *
78    * @param[in] controller A reference to the controller class
79    * @param[in] size The size to set
80    * @param[in] layoutDirection The layout direction
81    * @return
82    */
83   static Controller::UpdateTextType Relayout(Controller& controller, const Size& size, Dali::LayoutDirection::Type layoutDirection);
84
85   /**
86    * @brief Called by the Controller to do certain operations when relayouting.
87    *
88    * @param[in] controller A reference to the controller class
89    * @param[in] size The size to set
90    * @param[in] operationsRequired The operations we need to do
91    * @param[in/out] layoutSize The Layout size which can be updated depending on the result of the performed operations
92    * @return
93    */
94   static bool DoRelayout(Controller& controller, const Size& size, OperationsMask operationsRequired, Size& layoutSize);
95
96   /**
97    * @brief Called by the Controller to calculate the veritcal offset give the control size.
98    *
99    * @param[in] controller A reference to the controller class
100    * @param[in] controlSize The control size
101    */
102   static void CalculateVerticalOffset(Controller& controller, const Size& controlSize);
103
104   /**
105   * @brief Calculates the layout size of control according to @p requestedControllerSize and @p requestedOperationsMask
106   *
107   * GetNaturalSize() and GetHeightForWidth() calls this method.
108   *
109   * @param[in] controller The controller to calcualte size on it.
110   * @param[in] requestedControllerSize The requested size of controller to calcualte layout size on it.
111   * @param[in] requestedOperationsMask The requested operations-mask to calcualte layout size according to it.
112   * @param[in] restoreLinesAndGlyphPositions whether to restore lines and glyph-positions to status before requesting calculation on size.
113   *
114   * @return The calculated layout-size.
115   */
116   static Size CalculateLayoutSizeOnRequiredControllerSize(Controller& controller, const Size& requestedControllerSize, const OperationsMask& requestedOperationsMask, bool restoreLinesAndGlyphPositions);
117
118 };
119
120 } // namespace Text
121
122 } // namespace Toolkit
123
124 } // namespace Dali
125
126 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_RELAYOUTER_H