Dali-Text: Keyboard Shortcuts
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / text-view-interface.h
1 #ifndef DALI_TOOLKIT_TEXT_VIEW_INTERFACE_H
2 #define DALI_TOOLKIT_TEXT_VIEW_INTERFACE_H
3
4 /*
5  * Copyright (c) 2019 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 <dali-toolkit/internal/text/text-definitions.h>
23
24 namespace Dali
25 {
26
27 struct Vector2;
28 struct Vector4;
29
30 namespace Toolkit
31 {
32
33 namespace Text
34 {
35
36 struct GlyphRun;
37
38 /**
39  * @brief Abstract interface to provide the information necessary to display text.
40  *
41  * This includes:
42  * - The font & glyph IDs needed to get bitmaps etc. from TextAbstraction
43  * - The visual position of each glyph within the layout
44  * - A window into the text layout e.g. which page of a document to view
45  */
46 class ViewInterface
47 {
48 public:
49
50   /**
51    * @brief Constructor.
52    */
53   ViewInterface();
54
55   /**
56    * @brief Virtual destructor
57    */
58   virtual ~ViewInterface();
59
60   /**
61    * @brief Retrieves the target size of the UI control.
62    *
63    * @return The control's size.
64    */
65   virtual const Vector2& GetControlSize() const = 0;
66
67   /**
68    * @brief Retrieves the text's layout size.
69    *
70    * @return The text's size. Note that this may be larger than the control size,
71    * in the case where text is scrolling/clipped.
72    */
73   virtual const Vector2& GetLayoutSize() const = 0;
74
75   /**
76    * Retrieves the number of glyphs.
77    *
78    * @return The number of glyphs.
79    */
80   virtual Length GetNumberOfGlyphs() const = 0;
81
82   /**
83    * @brief Retrieves glyphs and positions in the given buffers.
84    *
85    * @note The size of the @p glyphs and @p glyphPositions buffers need to be big enough to copy the @p numberOfGlyphs glyphs and positions.
86    * @note The returned number of glyphs may be less than @p numberOfGlyphs if a line has ellipsis.
87    *
88    * @param[out] glyphs Pointer to a buffer where the glyphs are copied.
89    * @param[out] glyphPositions Pointer to a buffer where the glyph's positions are copied.
90    * @param[out] minLineOffset The minimum line offset.
91    * @param[in] glyphIndex Index to the first glyph.
92    * @param[in] numberOfGlyphs Number of glyphs to be copied.
93    *
94    * @return The number of glyphs.
95    */
96   virtual Length GetGlyphs( GlyphInfo* glyphs,
97                             Vector2* glyphPositions,
98                             float& minLineOffset,
99                             GlyphIndex glyphIndex,
100                             Length numberOfGlyphs ) const = 0;
101
102   /**
103    * @brief Retrieves the vector of colors.
104    *
105    * @return Pointer to the vector of colors.
106    */
107   virtual const Vector4* const GetColors() const = 0;
108
109   /**
110    * @brief Retrieves the vector of indices to the vector of colors.
111    *
112    * @return Pointer to a vector which stores for each glyph the index to the vector of colors.
113    */
114   virtual const ColorIndex* const GetColorIndices() const = 0;
115
116   /**
117    * @brief Retrieves the vector of background colors.
118    *
119    * @return Pointer to the vector of background colors.
120    */
121   virtual const Vector4* const GetBackgroundColors() const = 0;
122
123   /**
124    * @brief Retrieves the vector of indices to the vector of background colors.
125    *
126    * @return Pointer to a vector which stores for each glyph the index to the vector of background colors.
127    */
128   virtual const ColorIndex* const GetBackgroundColorIndices() const = 0;
129
130   /**
131    * @brief Retrieves the text color
132    *
133    * @return The text color
134    */
135   virtual const Vector4& GetTextColor() const = 0;
136
137   /**
138    * @brief Retrieves the shadow offset, 0 indicates no shadow.
139    *
140    * @return The shadow offset.
141    */
142   virtual const Vector2& GetShadowOffset() const = 0;
143
144   /**
145    * @brief Retrieves the shadow color.
146    *
147    * @return The shadow color.
148    */
149   virtual const Vector4& GetShadowColor() const = 0;
150
151   /**
152    * @brief Retrieves the underline color.
153    *
154    * @return The underline color.
155    */
156   virtual const Vector4& GetUnderlineColor() const = 0;
157
158   /**
159    * @brief Returns whether underline is enabled or not.
160    *
161    * @return The underline state.
162    */
163   virtual bool IsUnderlineEnabled() const = 0;
164
165   /**
166    * @brief Retrieves the underline height override
167    *
168    * @return Returns the override height for an underline, 0 indicates that adaptor will determine the height
169    */
170   virtual float GetUnderlineHeight() const = 0;
171
172   /**
173    * @brief Retrieves the number of underline runs.
174    *
175    * @return The number of underline runs.
176    */
177   virtual Length GetNumberOfUnderlineRuns() const = 0;
178
179   /**
180    * @brief Retrieves the underline runs.
181    *
182    * @param[out] underlineRuns Pointer to a buffer where the underline runs are copied.
183    * @param[in] index Index of the first underline run to be copied.
184    * @param[in] numberOfRuns Number of underline runs to be copied.
185    */
186   virtual void GetUnderlineRuns( GlyphRun* underlineRuns,
187                                  UnderlineRunIndex index,
188                                  Length numberOfRuns ) const = 0;
189
190   /**
191    * @brief Retrieve the outline color.
192    *
193    * @return The outline color.
194    */
195   virtual const Vector4& GetOutlineColor() const = 0;
196
197   /**
198    * @brief Retrieves the width of an outline
199    *
200    * @return The width of the outline.
201    */
202   virtual uint16_t GetOutlineWidth() const = 0;
203
204 };
205
206 } // namespace Text
207
208 } // namespace Toolkit
209
210 } // namespace Dali
211
212 #endif // DALI_TOOLKIT_TEXT_VIEW_INTERFACE_H