Differential D9569 Diff 24071 src/lib/evas/canvas/efl_canvas_text_canvas_eo.legacy.h

Changeset View

Standalone View

src/lib/evas/canvas/efl_canvas_text_canvas_eo.legacy.h

This file was moved from src/lib/evas/canvas/efl_canvas_text_eo.legacy.h.

1	#ifndef _EFL_CANVAS_TEXT_EO_LEGACY_H_	1	#ifndef _EFL_CANVAS_TEXT_EO_LEGACY_H_
2	#define _EFL_CANVAS_TEXT_EO_LEGACY_H_	2	#define _EFL_CANVAS_TEXT_EO_LEGACY_H_
3		3
4	#ifndef _EFL_CANVAS_TEXT_EO_CLASS_TYPE	4	#ifndef _EFL_CANVAS_TEXT_EO_CLASS_TYPE
5	#define _EFL_CANVAS_TEXT_EO_CLASS_TYPE	5	#define _EFL_CANVAS_TEXT_EO_CLASS_TYPE
6		6
7	typedef Eo Efl_Canvas_Text;	7	typedef Eo Efl_Canvas_Text_Canvas;
8		8
9	#endif	9	#endif
10		10
11	#ifndef _EFL_CANVAS_TEXT_EO_TYPES	11	#ifndef _EFL_CANVAS_TEXT_EO_TYPES
12	#define _EFL_CANVAS_TEXT_EO_TYPES	12	#define _EFL_CANVAS_TEXT_EO_TYPES
13		13
14		14
15	#endif	15	#endif
Show All 11 Lines
27	* @param[in] end Range end position	27	* @param[in] end Range end position
28	*	28	*
29	* @return @c true on success, @c false otherwise	29	* @return @c true on success, @c false otherwise
30	*	30	*
31	* @since 1.18	31	* @since 1.18
32	*	32	*
33	* @ingroup Evas_Object_Textblock_Group	33	* @ingroup Evas_Object_Textblock_Group
34	*/	34	*/
35	EAPI Eina_Bool evas_object_textblock_visible_range_get(Efl_Canvas_Text obj, Efl_Text_Cursor_Cursor start, Efl_Text_Cursor_Cursor *end);	35	EAPI Eina_Bool evas_object_textblock_visible_range_get(Efl_Canvas_Text_Canvas obj, Efl_Text_Cursor_Cursor start, Efl_Text_Cursor_Cursor *end);
36		36
37	/**	37	/**
38	* @brief Gets the left, right, top and bottom insets of the text.	38	* @brief Gets the left, right, top and bottom insets of the text.
39	*	39	*
40	* The inset is any applied padding on the text.	40	* The inset is any applied padding on the text.
41	*	41	*
42	* @param[in] obj The object.	42	* @param[in] obj The object.
43	* @param[out] left The left padding	43	* @param[out] left The left padding
44	* @param[out] right The right padding	44	* @param[out] right The right padding
45	* @param[out] top The top padding	45	* @param[out] top The top padding
46	* @param[out] bottom The bottom padding	46	* @param[out] bottom The bottom padding
47	*	47	*
48	* @since 1.18	48	* @since 1.18
49	*	49	*
50	* @ingroup Evas_Object_Textblock_Group	50	* @ingroup Evas_Object_Textblock_Group
51	*/	51	*/
52	EAPI void evas_object_textblock_style_insets_get(const Efl_Canvas_Text obj, int left, int right, int top, int *bottom);	52	EAPI void evas_object_textblock_style_insets_get(const Efl_Canvas_Text_Canvas obj, int left, int right, int top, int *bottom);
53		53
54	/**	54	/**
55	* @brief BiDi delimiters are used for in-paragraph separation of bidi	55	* @brief BiDi delimiters are used for in-paragraph separation of bidi
56	* segments. This is useful, for example, in the recipient fields of e-mail	56	* segments. This is useful, for example, in the recipient fields of e-mail
57	* clients where bidi oddities can occur when mixing RTL and LTR.	57	* clients where bidi oddities can occur when mixing RTL and LTR.
58	*	58	*
59	* @param[in] obj The object.	59	* @param[in] obj The object.
60	* @param[in] delim A null terminated string of delimiters, e.g ",\|" or @c null	60	* @param[in] delim A null terminated string of delimiters, e.g ",\|" or @c null
61	* if empty	61	* if empty
62	*	62	*
63	* @since 1.18	63	* @since 1.18
64	*	64	*
65	* @ingroup Evas_Object_Textblock_Group	65	* @ingroup Evas_Object_Textblock_Group
66	*/	66	*/
67	EAPI void evas_object_textblock_bidi_delimiters_set(Efl_Canvas_Text obj, const char delim);	67	EAPI void evas_object_textblock_bidi_delimiters_set(Efl_Canvas_Text_Canvas obj, const char delim);
68		68
69	/**	69	/**
70	* @brief BiDi delimiters are used for in-paragraph separation of bidi	70	* @brief BiDi delimiters are used for in-paragraph separation of bidi
71	* segments. This is useful, for example, in the recipient fields of e-mail	71	* segments. This is useful, for example, in the recipient fields of e-mail
72	* clients where bidi oddities can occur when mixing RTL and LTR.	72	* clients where bidi oddities can occur when mixing RTL and LTR.
73	*	73	*
74	* @param[in] obj The object.	74	* @param[in] obj The object.
75	*	75	*
76	* @return A null terminated string of delimiters, e.g ",\|" or @c null if empty	76	* @return A null terminated string of delimiters, e.g ",\|" or @c null if empty
77	*	77	*
78	* @since 1.18	78	* @since 1.18
79	*	79	*
80	* @ingroup Evas_Object_Textblock_Group	80	* @ingroup Evas_Object_Textblock_Group
81	*/	81	*/
82	EAPI const char evas_object_textblock_bidi_delimiters_get(const Efl_Canvas_Text obj);	82	EAPI const char evas_object_textblock_bidi_delimiters_get(const Efl_Canvas_Text_Canvas obj);
83		83
84	/**	84	/**
85	* @brief When @c true, newline character will behave as a paragraph separator.	85	* @brief When @c true, newline character will behave as a paragraph separator.
86	*	86	*
87	* @param[in] obj The object.	87	* @param[in] obj The object.
88	* @param[in] mode @c true for legacy mode, @c false otherwise	88	* @param[in] mode @c true for legacy mode, @c false otherwise
89	*	89	*
90	* @since 1.18	90	* @since 1.18
91	*	91	*
92	* @ingroup Evas_Object_Textblock_Group	92	* @ingroup Evas_Object_Textblock_Group
93	*/	93	*/
94	EAPI void evas_object_textblock_legacy_newline_set(Efl_Canvas_Text *obj, Eina_Bool mode);	94	EAPI void evas_object_textblock_legacy_newline_set(Efl_Canvas_Text_Canvas *obj, Eina_Bool mode);
95		95
96	/**	96	/**
97	* @brief When @c true, newline character will behave as a paragraph separator.	97	* @brief When @c true, newline character will behave as a paragraph separator.
98	*	98	*
99	* @param[in] obj The object.	99	* @param[in] obj The object.
100	*	100	*
101	* @return @c true for legacy mode, @c false otherwise	101	* @return @c true for legacy mode, @c false otherwise
102	*	102	*
103	* @since 1.18	103	* @since 1.18
104	*	104	*
105	* @ingroup Evas_Object_Textblock_Group	105	* @ingroup Evas_Object_Textblock_Group
106	*/	106	*/
107	EAPI Eina_Bool evas_object_textblock_legacy_newline_get(const Efl_Canvas_Text *obj);	107	EAPI Eina_Bool evas_object_textblock_legacy_newline_get(const Efl_Canvas_Text_Canvas *obj);
108		108
109		109
110		110
111	/**	111	/**
112	* @brief The formatted width and height.	112	* @brief The formatted width and height.
113	*	113	*
114	* This calculates the actual size after restricting the textblock to the	114	* This calculates the actual size after restricting the textblock to the
115	* current size of the object.	115	* current size of the object.
Show All 12 Lines
128	* @param[in] obj The object.	128	* @param[in] obj The object.
129	* @param[out] width The width of the object.	129	* @param[out] width The width of the object.
130	* @param[out] height The height of the object.	130	* @param[out] height The height of the object.
131	*	131	*
132	* @since 1.18	132	* @since 1.18
133	*	133	*
134	* @ingroup Evas_Object_Textblock_Group	134	* @ingroup Evas_Object_Textblock_Group
135	*/	135	*/
136	EAPI void evas_object_textblock_size_formatted_get(const Efl_Canvas_Text obj, int width, int *height);	136	EAPI void evas_object_textblock_size_formatted_get(const Efl_Canvas_Text_Canvas obj, int width, int *height);
137		137
138	/**	138	/**
139	* @brief The native width and height.	139	* @brief The native width and height.
140	*	140	*
141	* This calculates the actual size without taking account the current size of	141	* This calculates the actual size without taking account the current size of
142	* the object.	142	* the object.
143	*	143	*
144	* The main difference between this and	144	* The main difference between this and
Show All 11 Lines
156	* @param[in] obj The object.	156	* @param[in] obj The object.
157	* @param[out] width The width returned.	157	* @param[out] width The width returned.
158	* @param[out] height The height returned.	158	* @param[out] height The height returned.
159	*	159	*
160	* @since 1.18	160	* @since 1.18
161	*	161	*
162	* @ingroup Evas_Object_Textblock_Group	162	* @ingroup Evas_Object_Textblock_Group
163	*/	163	*/
164	EAPI void evas_object_textblock_size_native_get(const Efl_Canvas_Text obj, int width, int *height);	164	EAPI void evas_object_textblock_size_native_get(const Efl_Canvas_Text_Canvas obj, int width, int *height);
165		165
166		166
167		167
168		168
169		169
170	/**	170	/**
171	* @brief Add obstacle evas object @c eo_obs to be observed during layout of	171	* @brief Add obstacle evas object @c eo_obs to be observed during layout of
172	* text.	172	* text.
173	*	173	*
174	* The textblock does the layout of the text according to the position of the	174	* The textblock does the layout of the text according to the position of the
175	* obstacle.	175	* obstacle.
176	*	176	*
177	* @param[in] obj The object.	177	* @param[in] obj The object.
178	* @param[in] eo_obs Obstacle object	178	* @param[in] eo_obs Obstacle object
179	*	179	*
180	* @return @c true on success, @c false otherwise.	180	* @return @c true on success, @c false otherwise.
181	*	181	*
182	* @since 1.18	182	* @since 1.18
183	*	183	*
184	* @ingroup Evas_Object_Textblock_Group	184	* @ingroup Evas_Object_Textblock_Group
185	*/	185	*/
186	EAPI Eina_Bool evas_object_textblock_obstacle_add(Efl_Canvas_Text obj, Efl_Canvas_Object eo_obs);	186	EAPI Eina_Bool evas_object_textblock_obstacle_add(Efl_Canvas_Text_Canvas obj, Efl_Canvas_Object eo_obs);
187		187
188	/**	188	/**
189	* @brief Removes @c eo_obs from observation during text layout.	189	* @brief Removes @c eo_obs from observation during text layout.
190	*	190	*
191	* @param[in] obj The object.	191	* @param[in] obj The object.
192	* @param[in] eo_obs Obstacle object	192	* @param[in] eo_obs Obstacle object
193	*	193	*
194	* @return @c true on success, @c false otherwise.	194	* @return @c true on success, @c false otherwise.
195	*	195	*
196	* @since 1.18	196	* @since 1.18
197	*	197	*
198	* @ingroup Evas_Object_Textblock_Group	198	* @ingroup Evas_Object_Textblock_Group
199	*/	199	*/
200	EAPI Eina_Bool evas_object_textblock_obstacle_del(Efl_Canvas_Text obj, Efl_Canvas_Object eo_obs);	200	EAPI Eina_Bool evas_object_textblock_obstacle_del(Efl_Canvas_Text_Canvas obj, Efl_Canvas_Object eo_obs);
201		201
202	/**	202	/**
203	* @brief Triggers for relayout due to obstacles' state change.	203	* @brief Triggers for relayout due to obstacles' state change.
204	*	204	*
205	* The obstacles alone don't affect the layout, until this is called. Use this	205	* The obstacles alone don't affect the layout, until this is called. Use this
206	* after doing changes (moving, positioning etc.) in the obstacles that you	206	* after doing changes (moving, positioning etc.) in the obstacles that you
207	* would like to be considered in the layout.	207	* would like to be considered in the layout.
208	*	208	*
209	* For example: if you have just repositioned the obstacles to differrent	209	* For example: if you have just repositioned the obstacles to differrent
210	* coordinates relative to the textblock, you need to call this so it will	210	* coordinates relative to the textblock, you need to call this so it will
211	* consider this new state and will relayout the text.	211	* consider this new state and will relayout the text.
212	*	212	*
213	* @param[in] obj The object.	213	* @param[in] obj The object.
214	*	214	*
215	* @since 1.18	215	* @since 1.18
216	*	216	*
217	* @ingroup Evas_Object_Textblock_Group	217	* @ingroup Evas_Object_Textblock_Group
218	*/	218	*/
219	EAPI void evas_object_textblock_obstacles_update(Efl_Canvas_Text *obj);	219	EAPI void evas_object_textblock_obstacles_update(Efl_Canvas_Text_Canvas *obj);
220		220
221		221
222	#endif	222	#endif