summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVivek Ellur <vivek.ellur@samsung.com>2015-08-07 13:04:27 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-08-07 13:04:27 +0100
commitf218bbb01c1d1671bb3ac92b9d48b5f8c1b89692 (patch)
treecd2b5aaa4038b57d92d76db8a621fd333ae365bc
parent4c18656303faa362a16b9b49c53b31e0c02e44ec (diff)
elm_entry: Convert eo docs to new format
Summary: Changed elm_entry.eo docs to the new format Signed-off-by: Vivek Ellur <vivek.ellur@samsung.com> Reviewers: cedric, q66 Reviewed By: q66 Differential Revision: https://phab.enlightenment.org/D2924
-rw-r--r--src/lib/elm_entry.eo1092
1 files changed, 365 insertions, 727 deletions
diff --git a/src/lib/elm_entry.eo b/src/lib/elm_entry.eo
index e15334a67..33819e190 100644
--- a/src/lib/elm_entry.eo
+++ b/src/lib/elm_entry.eo
@@ -104,97 +104,74 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
104 methods { 104 methods {
105 @property scrollable { 105 @property scrollable {
106 set { 106 set {
107 /*@ 107 [[Enable or disable scrolling in entry
108 Enable or disable scrolling in entry
109 108
110 Normally the entry is not scrollable unless you enable it with this call. 109 Normally the entry is not scrollable unless you enable it with this call.
111 110 ]]
112 @ingroup Entry */
113 } 111 }
114 get { 112 get {
115 /*@ 113 [[Get the scrollable state of the entry
116 Get the scrollable state of the entry
117
118 Normally the entry is not scrollable. This gets the scrollable state
119 of the entry. See elm_entry_scrollable_set() for more information.
120
121 @return The scrollable state
122 114
123 @ingroup Entry */ 115 Normally the entry is not scrollable. This gets the scrollable state
116 of the entry.
117 ]]
124 } 118 }
125 values { 119 values {
126 scroll: bool; /*@ true if it is to be scrollable, false otherwise */ 120 scroll: bool; [[$true if it is to be scrollable, $false otherwise.]]
127 } 121 }
128 } 122 }
129 @property input_panel_show_on_demand { 123 @property input_panel_show_on_demand {
130 set { 124 set {
131 /*@ 125 [[Set the attribute to show the input panel in case of only an user's explicit Mouse Up event.
132 Set the attribute to show the input panel in case of only an user's explicit Mouse Up event. 126 It doesn't request to show the input panel even though it has focus.
133 It doesn't request to show the input panel even though it has focus. 127 ]]
134
135 @ingroup Entry */
136 } 128 }
137 get { 129 get {
138 /*@ 130 [[Get the attribute to show the input panel in case of only an user's explicit Mouse Up event.
139 Get the attribute to show the input panel in case of only an user's explicit Mouse Up event.
140
141 @return $true if the input panel will be shown in case of only Mouse up event.
142 @since 1.9
143 131
144 @ingroup Entry */ 132 @since 1.9
133 ]]
145 } 134 }
146 values { 135 values {
147 ondemand: bool; /*@ If true, the input panel will be shown in case of only Mouse up event. 136 ondemand: bool; [[If true, the input panel will be shown in case of only Mouse up event.
148 (Focus event will be ignored.) 137 (Focus event will be ignored.)
149 @since 1.9 */ 138
139 @since 1.9.]]
150 } 140 }
151 } 141 }
152 @property context_menu_disabled { 142 @property context_menu_disabled {
153 set { 143 set {
154 /*@ 144 [[This disables the entry's contextual (longpress) menu.]]
155 This disables the entry's contextual (longpress) menu.
156
157 @ingroup Entry */
158 } 145 }
159 get { 146 get {
160 /*@ 147 [[This returns whether the entry's contextual (longpress) menu is
161 This returns whether the entry's contextual (longpress) menu is 148 disabled.
162 disabled. 149 ]]
163
164 @return If true, the menu is disabled
165
166 @ingroup Entry */
167 } 150 }
168 values { 151 values {
169 disabled: bool; /*@ If true, the menu is disabled */ 152 disabled: bool; [[If $true, the menu is disabled.]]
170 } 153 }
171 } 154 }
172 @property cnp_mode { 155 @property cnp_mode {
173 set { 156 set {
174 /*@ 157 [[Control pasting of text and images for the widget.
175 Control pasting of text and images for the widget.
176 158
177 Normally the entry allows both text and images to be pasted. 159 Normally the entry allows both text and images to be pasted.
178 By setting cnp_mode to be #ELM_CNP_MODE_NO_IMAGE, this prevents images from being copy or past. 160 By setting cnp_mode to be #ELM_CNP_MODE_NO_IMAGE, this prevents images from being copy or past.
179 By setting cnp_mode to be #ELM_CNP_MODE_PLAINTEXT, this remove all tags in text . 161 By setting cnp_mode to be #ELM_CNP_MODE_PLAINTEXT, this remove all tags in text .
180 162
181 @note this only changes the behaviour of text. 163 Note: This only changes the behaviour of text.
182 164 ]]
183 @ingroup Entry */
184 } 165 }
185 get { 166 get {
186 /*@ 167 [[Getting elm_entry text paste/drop mode.
187 Getting elm_entry text paste/drop mode.
188
189 Normally the entry allows both text and images to be pasted.
190 This gets the copy & paste mode of the entry.
191
192 @return mode One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP, #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
193 168
194 @ingroup Entry */ 169 Normally the entry allows both text and images to be pasted.
170 This gets the copy & paste mode of the entry.
171 ]]
195 } 172 }
196 values { 173 values {
197 cnp_mode: Elm_Cnp_Mode; /*@ One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP, #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT. */ 174 cnp_mode: Elm_Cnp_Mode; [[One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP, #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.]]
198 } 175 }
199 } 176 }
200 @property file_text_format { 177 @property file_text_format {
@@ -217,1042 +194,703 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
217 } 194 }
218 @property input_panel_language { 195 @property input_panel_language {
219 set { 196 set {
220 /*@ 197 [[Set the language mode of the input panel.
221 Set the language mode of the input panel.
222 198
223 This API can be used if you want to show the alphabet keyboard mode. 199 This API can be used if you want to show the alphabet keyboard mode.
224 200 ]]
225 @ingroup Entry */
226 } 201 }
227 get { 202 get {
228 /*@ 203 [[Get the language mode of the input panel.]]
229 Get the language mode of the input panel.
230
231 See @ref elm_entry_input_panel_language_set for more details.
232
233 @return input panel language type
234
235 @ingroup Entry */
236 } 204 }
237 values { 205 values {
238 lang: Elm.Input.Panel.Lang; /*@ language to be set to the input panel. */ 206 lang: Elm.Input.Panel.Lang; [[language to be set to the input panel.]]
239 } 207 }
240 } 208 }
241 @property selection_handler_disabled { 209 @property selection_handler_disabled {
242 set { 210 set {
243 /*@ 211 [[This disabled the entry's selection handlers.]]
244 This disabled the entry's selection handlers.
245
246 @ingroup Entry */
247 } 212 }
248 get { 213 get {
249 /*@ This returns whether the entry's selection handlers are disabled. */ 214 [[This returns whether the entry's selection handlers are disabled.]]
250 legacy: null; 215 legacy: null;
251 } 216 }
252 values { 217 values {
253 disabled: bool; /*@ If true, the selection handlers are disabled. */ 218 disabled: bool; [[If $true, the selection handlers are disabled.]]
254 } 219 }
255 } 220 }
256 @property input_panel_layout_variation { 221 @property input_panel_layout_variation {
257 set { 222 set {
258 /*@ 223 [[Set the input panel layout variation of the entry
259 Set the input panel layout variation of the entry
260 224
261 @ingroup Entry 225 @since 1.8
262 @since 1.8 */ 226 ]]
263 } 227 }
264 get { 228 get {
265 /*@ 229 [[Get the input panel layout variation of the entry
266 Get the input panel layout variation of the entry
267
268 @return layout variation type
269 230
270 @see elm_entry_input_panel_layout_variation_set 231 @since 1.8
271 232 ]]
272 @ingroup Entry
273 @since 1.8 */
274 } 233 }
275 values { 234 values {
276 variation: int; /*@ layout variation type */ 235 variation: int; [[layout variation type.]]
277 } 236 }
278 } 237 }
279 @property autocapital_type { 238 @property autocapital_type {
280 set { 239 set {
281 /*@ 240 [[Set the autocapitalization type on the immodule.]]
282 Set the autocapitalization type on the immodule.
283
284 @ingroup Entry */
285 } 241 }
286 get { 242 get {
287 /*@ 243 [[Get the autocapitalization type on the immodule.]]
288 Get the autocapitalization type on the immodule.
289
290 @return autocapitalization type
291
292 @ingroup Entry */
293 } 244 }
294 values { 245 values {
295 autocapital_type: Elm.Autocapital.Type; /*@ The type of autocapitalization */ 246 autocapital_type: Elm.Autocapital.Type; [[The type of autocapitalization.]]
296 } 247 }
297 } 248 }
298 @property editable { 249 @property editable {
299 set { 250 set {
300 /*@ 251 [[Sets if the entry is to be editable or not.
301 Sets if the entry is to be editable or not.
302
303 By default, entries are editable and when focused, any text input by the
304 user will be inserted at the current cursor position. But calling this
305 function with $editable as false will prevent the user from
306 inputting text into the entry.
307 252
308 The only way to change the text of a non-editable entry is to use 253 By default, entries are editable and when focused, any text input by the
309 elm_object_text_set(), elm_entry_entry_insert() and other related 254 user will be inserted at the current cursor position. But calling this
310 functions. 255 function with $editable as $false will prevent the user from
256 inputting text into the entry.
311 257
312 @ingroup Entry */ 258 The only way to change the text of a non-editable entry is to use
259 \@ref elm_object_text_set, \@ref elm_entry_entry_insert and other related
260 functions.
261 ]]
313 } 262 }
314 get { 263 get {
315 /*@ 264 [[Get whether the entry is editable or not.]]
316 Get whether the entry is editable or not.
317
318 @return If true, the entry is editable by the user.
319 If false, it is not editable by the user
320
321 @see elm_entry_editable_set()
322
323 @ingroup Entry */
324 } 265 }
325 values { 266 values {
326 editable: bool; /*@ If true, user input will be inserted in the entry, 267 editable: bool; [[If $true, user input will be inserted in the entry,
327 if not, the entry is read-only and no user input is allowed. */ 268 if not, the entry is read-only and no user input is allowed.]]
328 } 269 }
329 } 270 }
330 @property anchor_hover_style { 271 @property anchor_hover_style {
331 set { 272 set {
332 /*@ 273 [[Set the style that the hover should use
333 Set the style that the hover should use
334
335 When creating the popup hover, entry will request that it's
336 themed according to $style.
337 274
338 Setting style no $NULL means disabling automatic hover. 275 When creating the popup hover, entry will request that it's
276 themed according to $style.
339 277
340 @see elm_object_style_set() 278 Setting style no $null means disabling automatic hover.
341 279 ]]
342 @ingroup Entry */
343 } 280 }
344 get { 281 get {
345 /*@ 282 [[Get the style that the hover should use.]]
346 Get the style that the hover should use
347
348 Get the style, the hover created by entry will use.
349
350 @return The style to use by the hover. $NULL means the default is used.
351
352 @see elm_object_style_set()
353
354 @ingroup Entry */
355 } 283 }
356 values { 284 values {
357 style: const(char)* @nullable; /*@ The style to use for the underlying hover */ 285 style: const(char)* @nullable; [[The style to use for the underlying hover.]]
358 } 286 }
359 } 287 }
360 @property single_line { 288 @property single_line {
361 set { 289 set {
362 /*@ 290 [[Sets the entry to single line mode.
363 Sets the entry to single line mode.
364
365 In single line mode, entries don't ever wrap when the text reaches the
366 edge, and instead they keep growing horizontally. Pressing the $Enter
367 key will generate an $"activate" event instead of adding a new line.
368 291
369 When $single_line is $false, line wrapping takes effect again 292 In single line mode, entries don't ever wrap when the text reaches the
370 and pressing enter will break the text into a different line 293 edge, and instead they keep growing horizontally. Pressing the $Enter
371 without generating any events. 294 key will generate an $"activate" event instead of adding a new line.
372 295
373 @ingroup Entry */ 296 When $single_line is $false, line wrapping takes effect again
297 and pressing enter will break the text into a different line
298 without generating any events.
299 ]]
374 } 300 }
375 get { 301 get {
376 /*@ 302 [[Get whether the entry is set to be single line.]]
377 Get whether the entry is set to be single line.
378
379 @return single_line If true, the text in the entry is set to display
380 on a single line.
381
382 @see elm_entry_single_line_set()
383
384 @ingroup Entry */
385 } 303 }
386 values { 304 values {
387 single_line: bool; /*@ If true, the text in the entry 305 single_line: bool; [[If true, the text in the entry
388 will be on a single line. */ 306 will be on a single line.]]
389 } 307 }
390 } 308 }
391 @property password { 309 @property password {
392 set { 310 set {
393 /*@ 311 [[Sets the entry to password mode.
394 Sets the entry to password mode.
395 312
396 In password mode, entries are implicitly single line and the display of 313 In password mode, entries are implicitly single line and the display of
397 any text in them is replaced with asterisks (*). 314 any text in them is replaced with asterisks (*).
398 315 ]]
399 @ingroup Entry */
400 } 316 }
401 get { 317 get {
402 /*@ 318 [[Get whether the entry is set to password mode.]]
403 Get whether the entry is set to password mode.
404
405 @return If true, the entry is set to display all characters
406 as asterisks (*).
407
408 @see elm_entry_password_set()
409
410 @ingroup Entry */
411 } 319 }
412 values { 320 values {
413 password: bool; /*@ If true, password mode is enabled. */ 321 password: bool; [[If true, password mode is enabled.]]
414 } 322 }
415 } 323 }
416 @property input_panel_return_key_disabled { 324 @property input_panel_return_key_disabled {
417 set { 325 set {
418 /*@ 326 [[Set the return key on the input panel to be disabled.]]
419 Set the return key on the input panel to be disabled.
420
421 @ingroup Entry */
422 } 327 }
423 get { 328 get {
424 /*@ 329 [[Get whether the return key on the input panel should be disabled or not.]]
425 Get whether the return key on the input panel should be disabled or not.
426
427 @return true if it should be disabled
428
429 @ingroup Entry */
430 } 330 }
431 values { 331 values {
432 disabled: bool; /*@ The state to put in in: $true for 332 disabled: bool; [[The state to put in in: $true for
433 disabled, $false for enabled */ 333 disabled, $false for enabled.]]
434 } 334 }
435 } 335 }
436 @property autosave { 336 @property autosave {
437 set { 337 set {
438 /*@ 338 [[This sets the entry object to 'autosave' the loaded text file or not.]]
439 This sets the entry object to 'autosave' the loaded text file or not.
440
441 @see elm_entry_file_set()
442
443 @ingroup Entry */
444 } 339 }
445 get { 340 get {
446 /*@ 341 [[This gets the entry object's 'autosave' status.]]
447 This gets the entry object's 'autosave' status.
448
449 @return Autosave the loaded file or not
450
451 @see elm_entry_file_set()
452
453 @ingroup Entry */
454 } 342 }
455 values { 343 values {
456 auto_save: bool; /*@ Autosave the loaded file or not */ 344 auto_save: bool; [[Autosave the loaded file or not.]]
457 } 345 }
458 } 346 }
459 @property anchor_hover_parent { 347 @property anchor_hover_parent {
460 set { 348 set {
461 /*@ 349 [[Set the parent of the hover popup
462 Set the parent of the hover popup
463 350
464 Sets the parent object to use by the hover created by the entry 351 Sets the parent object to use by the hover created by the entry
465 when an anchor is clicked. See @ref Hover for more details on this. 352 when an anchor is clicked.
466 353 ]]
467 @ingroup Entry */
468 } 354 }
469 get { 355 get {
470 /*@ 356 [[Get the parent of the hover popup
471 Get the parent of the hover popup
472
473 Get the object used as parent for the hover created by the entry
474 widget. See @ref Hover for more details on this.
475 If no parent is set, the same entry object will be used.
476
477 @return The object used as parent for the hover, NULL if none is set.
478 357
479 @ingroup Entry */ 358 Get the object used as parent for the hover created by the entry
359 widget. If no parent is set, the same entry object will be used.
360 ]]
480 } 361 }
481 values { 362 values {
482 parent: Evas.Object * @nullable; /*@ The object to use as parent for the hover */ 363 parent: Evas.Object * @nullable; [[The object to use as parent for the hover.]]
483 } 364 }
484 } 365 }
485 @property prediction_allow { 366 @property prediction_allow {
486 set { 367 set {
487 /*@ 368 [[Set whether the entry should allow to use the text prediction.]]
488 Set whether the entry should allow to use the text prediction.
489
490 @ingroup Entry */
491 } 369 }
492 get { 370 get {
493 /*@ 371 [[Get whether the entry should allow to use the text prediction.]]
494 Get whether the entry should allow to use the text prediction.
495
496 @return true if it allows to use the text prediction, otherwise false.
497
498 @ingroup Entry */
499 } 372 }
500 values { 373 values {
501 prediction: bool; /*@ Whether the entry should allow to use the text prediction. */ 374 prediction: bool; [[Whether the entry should allow to use the text prediction.]]
502 } 375 }
503 } 376 }
504 @property input_hint { 377 @property input_hint {
505 set { 378 set {
506 /*@ 379 [[Sets the input hint which allows input methods to fine-tune their behavior.]]
507 Sets the input hint which allows input methods to fine-tune their behavior.
508
509 @ingroup Entry */
510 } 380 }
511 get { 381 get {
512 /*@ 382 [[Gets the value of input hint.]]
513 Gets the value of input hint.
514
515 @return the value of input hint.
516
517 @see elm_entry_input_hint_set
518
519 @ingroup Entry */
520 } 383 }
521 values { 384 values {
522 hints: Elm.Input.Hints; /*@ input hint. */ 385 hints: Elm.Input.Hints; [[Input hint.]]
523 } 386 }
524 } 387 }
525 @property input_panel_layout { 388 @property input_panel_layout {
526 set { 389 set {
527 /*@ 390 [[Set the input panel layout of the entry.]]
528 Set the input panel layout of the entry
529
530 @ingroup Entry */
531 } 391 }
532 get { 392 get {
533 /*@ 393 [[Get the input panel layout of the entry.]]
534 Get the input panel layout of the entry
535
536 @return layout type. It returns ELM_INPUT_PANEL_LAYOUT_INVALID(8) when it fails.
537
538 @see elm_entry_input_panel_layout_set
539
540 @ingroup Entry */
541 } 394 }
542 values { 395 values {
543 layout: Elm.Input.Panel.Layout(Elm.Input.Panel.Layout.invalid); /*@ layout type */ 396 layout: Elm.Input.Panel.Layout(Elm.Input.Panel.Layout.invalid); [[layout type.]]
544 } 397 }
545 } 398 }
546 @property input_panel_return_key_type { 399 @property input_panel_return_key_type {
547 set { 400 set {
548 /*@ 401 [[Set the "return" key type. This type is used to set string or icon on the "return" key of the input panel.
549 Set the "return" key type. This type is used to set string or icon on the "return" key of the input panel.
550
551 An input panel displays the string or icon associated with this type
552 402
553 @ingroup Entry */ 403 An input panel displays the string or icon associated with this type.
404 ]]
554 } 405 }
555 get { 406 get {
556 /*@ 407 [[Get the "return" key type.]]
557 Get the "return" key type.
558
559 @see elm_entry_input_panel_return_key_type_set() for more details
560
561 @return The type of "return" key on the input panel
562
563 @ingroup Entry */
564 } 408 }
565 values { 409 values {
566 return_key_type: Elm.Input.Panel.Return_Key.Type; /*@ The type of "return" key on the input panel */ 410 return_key_type: Elm.Input.Panel.Return_Key.Type; [[The type of "return" key on the input panel.]]
567 } 411 }
568 } 412 }
569 @property input_panel_enabled { 413 @property input_panel_enabled {
570 set { 414 set {
571 /*@ 415 [[Sets the attribute to show the input panel automatically.]]
572 Sets the attribute to show the input panel automatically.
573
574 @ingroup Entry */
575 } 416 }
576 get { 417 get {
577 /*@ 418 [[Get the attribute to show the input panel automatically.]]
578 Get the attribute to show the input panel automatically.
579
580 @return true if input panel will be appeared when the entry is clicked or has a focus, false otherwise
581
582 @ingroup Entry */
583 } 419 }
584 values { 420 values {
585 enabled: bool; /*@ If true, the input panel is appeared when entry is clicked or has a focus */ 421 enabled: bool; [[If true, the input panel is appeared when entry is clicked or has a focus.]]
586 } 422 }
587 } 423 }
588 @property line_wrap { 424 @property line_wrap {
589 set { 425 set {
590 /*@ 426 [[Set the line wrap type to use on multi-line entries.
591 Set the line wrap type to use on multi-line entries.
592 427
593 Sets the wrap type used by the entry to any of the specified in 428 Sets the wrap type used by the entry to any of the specified in
594 Elm_Wrap_Type. This tells how the text will be implicitly cut into a new 429 Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
595 line (without inserting a line break or paragraph separator) when it 430 line (without inserting a line break or paragraph separator) when it
596 reaches the far edge of the widget. 431 reaches the far edge of the widget.
597 432
598 Note that this only makes sense for multi-line entries. A widget set 433 Note that this only makes sense for multi-line entries. A widget set
599 to be single line will never wrap. 434 to be single line will never wrap.
600 435 ]]
601 @ingroup Entry */
602 } 436 }
603 get { 437 get {
604 /*@ 438 [[Get the wrap mode the entry was set to use.]]
605 Get the wrap mode the entry was set to use.
606
607 @return Wrap type
608
609 @see also elm_entry_line_wrap_set()
610
611 @ingroup Entry */
612 } 439 }
613 values { 440 values {
614 wrap: Elm.Wrap.Type; /*@ The wrap mode to use. See Elm_Wrap_Type for details on them */ 441 wrap: Elm.Wrap.Type; [[The wrap mode to use. See Elm_Wrap_Type for details on them.]]
615 } 442 }
616 } 443 }
617 @property cursor_pos { 444 @property cursor_pos {
618 set { 445 set {
619 /*@ 446 [[Sets the cursor position in the entry to the given value
620 Sets the cursor position in the entry to the given value
621
622 The value in $pos is the index of the character position within the
623 contents of the string as returned by elm_entry_cursor_pos_get().
624 447
625 @ingroup Entry */ 448 The value in $pos is the index of the character position within the
449 contents of the string as returned by @.cursor_pos.get.
450 ]]
626 } 451 }
627 get { 452 get {
628 /*@ 453 [[Get the current position of the cursor in the entry.]]
629 Get the current position of the cursor in the entry
630
631 @return The cursor position
632
633 @ingroup Entry */
634 } 454 }
635 values { 455 values {
636 pos: int; /*@ The position of the cursor */ 456 pos: int; [[The position of the cursor.]]
637 } 457 }
638 } 458 }
639 @property icon_visible { 459 @property icon_visible {
640 set { 460 set {
641 /*@ 461 [[Sets the visibility of the left-side widget of the entry,
642 Sets the visibility of the left-side widget of the entry, 462 set by \@ref elm_object_part_content_set.]]
643 set by elm_object_part_content_set().
644
645 @ingroup Entry */
646 } 463 }
647 values { 464 values {
648 setting: bool; /*@ true if the object should be displayed, 465 setting: bool; [[$true if the object should be displayed,
649 false if not. */ 466 $false if not.]]
650 } 467 }
651 } 468 }
652 @property cursor_line_end { 469 @property cursor_line_end {
653 set { 470 set {
654 /*@ 471 [[This moves the cursor to the end of the current line.]]
655 This moves the cursor to the end of the current line.
656
657 @ingroup Entry */
658 } 472 }
659 } 473 }
660 @property select_region { 474 @property select_region {
661 set { 475 set {
662 /*@ 476 [[This selects a region of text within the entry.
663 This selects a region of text within the entry.
664 477
665 @ingroup Entry 478 @since 1.9
666 @since 1.9 */ 479 ]]
667 } 480 }
668 values { 481 values {
669 start: int; /*@ The starting position */ 482 start: int; [[The starting position.]]
670 end: int; /*@ The end position */ 483 end: int; [[The end position.]]
671 } 484 }
672 } 485 }
673 @property input_panel_return_key_autoenabled { 486 @property input_panel_return_key_autoenabled {
674 set { 487 set {
675 /*@ 488 [[Set whether the return key on the input panel is disabled automatically when entry has no text.
676 Set whether the return key on the input panel is disabled automatically when entry has no text.
677 489
678 If $enabled is true, The return key on input panel is disabled when the entry has no text. 490 If $enabled is $true, The return key on input panel is disabled when the entry has no text.
679 The return key on the input panel is automatically enabled when the entry has text. 491 The return key on the input panel is automatically enabled when the entry has text.
680 The default value is false. 492 The default value is $false.
681 493 ]]
682 @ingroup Entry */
683 } 494 }
684 values { 495 values {
685 enabled: bool; /*@ If $enabled is true, the return key is automatically disabled when the entry has no text. */ 496 enabled: bool; [[If $enabled is true, the return key is automatically disabled when the entry has no text.]]
686 } 497 }
687 } 498 }
688 @property end_visible { 499 @property end_visible {
689 set { 500 set {
690 /*@ 501 [[Sets the visibility of the end widget of the entry, set by
691 Sets the visibility of the end widget of the entry, set by 502 \@ref elm_object_part_content_set(ent, "end", content).]]
692 elm_object_part_content_set(ent, "end", content).
693
694 @ingroup Entry */
695 } 503 }
696 values { 504 values {
697 setting: bool; /*@ true if the object should be displayed, 505 setting: bool; [[true if the object should be displayed,
698 false if not. */ 506 false if not.]]
699 } 507 }
700 } 508 }
701 @property cursor_begin { 509 @property cursor_begin {
702 set { 510 set {
703 /*@ 511 [[This moves the cursor to the beginning of the entry.]]
704 This moves the cursor to the beginning of the entry.
705
706 @ingroup Entry */
707 } 512 }
708 } 513 }
709 @property cursor_line_begin { 514 @property cursor_line_begin {
710 set { 515 set {
711 /*@ 516 [[This moves the cursor to the beginning of the current line.]]
712 This moves the cursor to the beginning of the current line.
713
714 @ingroup Entry */
715 } 517 }
716 } 518 }
717 @property cursor_end { 519 @property cursor_end {
718 set { 520 set {
719 /*@ 521 [[This moves the cursor to the end of the entry.]]
720 This moves the cursor to the end of the entry.
721
722 @ingroup Entry */
723 } 522 }
724 } 523 }
725 @property textblock { 524 @property textblock {
726 get { 525 get {
727 /*@ 526 [[
728 Returns the actual textblock object of the entry. 527 Returns the actual textblock object of the entry.
729 528
730 This function exposes the internal textblock object that actually 529 This function exposes the internal textblock object that actually
731 contains and draws the text. This should be used for low-level 530 contains and draws the text. This should be used for low-level
732 manipulations that are otherwise not possible. 531 manipulations that are otherwise not possible.
733 532
734 Changing the textblock directly from here will not notify edje/elm to 533 Changing the textblock directly from here will not notify edje/elm to
735 recalculate the textblock size automatically, so any modifications 534 recalculate the textblock size automatically, so any modifications
736 done to the textblock returned by this function should be followed by 535 done to the textblock returned by this function should be followed by
737 a call to elm_entry_calc_force(). 536 a call to \@ref elm_entry_calc_force.
738 537
739 The return value is marked as const as an additional warning. 538 The return value is marked as const as an additional warning.
740 One should not use the returned object with any of the generic evas 539 One should not use the returned object with any of the generic evas
741 functions (geometry_get/resize/move and etc), but only with the textblock 540 functions (geometry_get/resize/move and etc), but only with the textblock
742 functions; The former will either not work at all, or break the correct 541 functions; The former will either not work at all, or break the correct
743 functionality. 542 functionality.
744 543
745 IMPORTANT: Many functions may change (i.e delete and create a new one) 544 IMPORTANT: Many functions may change (i.e delete and create a new one)
746 the internal textblock object. Do NOT cache the returned object, and try 545 the internal textblock object. Do NOT cache the returned object, and try
747 not to mix calls on this object with regular elm_entry calls (which may 546 not to mix calls on this object with regular elm_entry calls (which may
748 change the internal textblock object). This applies to all cursors 547 change the internal textblock object). This applies to all cursors
749 returned from textblock calls, and all the other derivative values. 548 returned from textblock calls, and all the other derivative values.
750 549 ]]
751 @return The textblock object.
752
753 @ingroup Entry */
754 return: Evas.Object *; 550 return: Evas.Object *;
755 } 551 }
756 } 552 }
757 @property cursor_geometry { 553 @property cursor_geometry {
758 get { 554 get {
759 /*@ 555 [[This function returns the geometry of the cursor.
760 This function returns the geometry of the cursor.
761
762 It's useful if you want to draw something on the cursor (or where it is),
763 or for example in the case of scrolled entry where you want to show the
764 cursor.
765 556
766 @return true upon success, false upon failure 557 It's useful if you want to draw something on the cursor (or where it is),
767 558 or for example in the case of scrolled entry where you want to show the
768 @ingroup Entry */ 559 cursor.
560 ]]
769 return: bool; 561 return: bool;
770 } 562 }
771 values { 563 values {
772 x: Evas.Coord; /*@ returned geometry */ 564 x: Evas.Coord; [[returned geometry.]]
773 y: Evas.Coord; /*@ returned geometry */ 565 y: Evas.Coord; [[returned geometry.]]
774 w: Evas.Coord; /*@ returned geometry */ 566 w: Evas.Coord; [[returned geometry.]]
775 h: Evas.Coord; /*@ returned geometry */ 567 h: Evas.Coord; [[returned geometry.]]
776 } 568 }
777 } 569 }
778 @property imf_context { 570 @property imf_context {
779 get { 571 get {
780 /*@ 572 [[Returns the input method context of the entry.
781 Returns the input method context of the entry.
782
783 This function exposes the internal input method context.
784
785 IMPORTANT: Many functions may change (i.e delete and create a new one)
786 the internal input method context. Do NOT cache the returned object.
787 573
788 @return The input method context (Ecore_IMF_Context *) in entry. 574 This function exposes the internal input method context.
789 575
790 @ingroup Entry */ 576 IMPORTANT: Many functions may change (i.e delete and create a new one)
577 the internal input method context. Do NOT cache the returned object.
578 ]]
791 return: void *; 579 return: void *;
792 } 580 }
793 } 581 }
794 @property cursor_is_format { 582 @property cursor_is_format {
795 get { 583 get {
796 /*@ 584 [[Get whether a format node exists at the current cursor position.
797 Get whether a format node exists at the current cursor position. 585
798 586 A format node is anything that defines how the text is rendered. It can
799 A format node is anything that defines how the text is rendered. It can 587 be a visible format node, such as a line break or a paragraph separator,
800 be a visible format node, such as a line break or a paragraph separator, 588 or an invisible one, such as bold begin or end tag.
801 or an invisible one, such as bold begin or end tag. 589 This function returns whether any format node exists at the current
802 This function returns whether any format node exists at the current 590 cursor position.
803 cursor position. 591 ]]
804
805 @return true if the current cursor position contains a format node,
806 false otherwise.
807
808 @see elm_entry_cursor_is_visible_format_get()
809
810 @ingroup Entry */
811 return: bool; 592 return: bool;
812 } 593 }
813 } 594 }
814 @property cursor_content { 595 @property cursor_content {
815 get { 596 get {
816 /*@ 597 [[Get the character pointed by the cursor at its current position.
817 Get the character pointed by the cursor at its current position.
818
819 This function returns a string with the utf8 character stored at the
820 current cursor position.
821 Only the text is returned, any format that may exist will not be part
822 of the return value. You must free the string when done with free().
823
824 @return The text pointed by the cursors.
825 598
826 @ingroup Entry */ 599 This function returns a string with the utf8 character stored at the
600 current cursor position.
601 Only the text is returned, any format that may exist will not be part
602 of the return value. You must free the string when done with \@ref free.
603 ]]
827 return: own(char *) @warn_unused; 604 return: own(char *) @warn_unused;
828 } 605 }
829 } 606 }
830 @property selection { 607 @property selection {
831 get { 608 get {
832 /*@ 609 [[Get any selected text within the entry.
833 Get any selected text within the entry.
834 610
835 If there's any selected text in the entry, this function returns it as 611 If there's any selected text in the entry, this function returns it as
836 a string in markup format. NULL is returned if no selection exists or 612 a string in markup format. $null is returned if no selection exists or
837 if an error occurred. 613 if an error occurred.
838 614
839 The returned value points to an internal string and should not be freed 615 The returned value points to an internal string and should not be freed
840 or modified in any way. If the $entry object is deleted or its 616 or modified in any way. If the $entry object is deleted or its
841 contents are changed, the returned pointer should be considered invalid. 617 contents are changed, the returned pointer should be considered invalid.
842 618 ]]
843 @return The selected text within the entry or NULL on failure
844
845 @ingroup Entry */
846 return: const(char)*; 619 return: const(char)*;
847 } 620 }
848 } 621 }
849 @property cursor_is_visible_format { 622 @property cursor_is_visible_format {
850 get { 623 get {
851 /*@ 624 [[Get if the current cursor position holds a visible format node.]]
852 Get if the current cursor position holds a visible format node.
853
854 @return true if the current cursor is a visible format, false
855 if it's an invisible one or no format exists.
856
857 @see elm_entry_cursor_is_format_get()
858
859 @ingroup Entry */
860 return: bool; 625 return: bool;
861 } 626 }
862 } 627 }
863 cursor_prev { 628 cursor_prev {
864 /*@ 629 [[This moves the cursor one place to the left within the entry.]]
865 This moves the cursor one place to the left within the entry.
866
867 @return true upon success, false upon failure
868
869 @ingroup Entry */
870
871 return: bool; 630 return: bool;
872 } 631 }
873 text_style_user_pop { 632 text_style_user_pop {
874 /*@ 633 [[Remove the style in the top of user style stack.
875 Remove the style in the top of user style stack.
876
877 @see elm_entry_text_style_user_push()
878
879 @ingroup Entry
880 @since 1.7 */
881 634
635 @since 1.7
636 ]]
882 } 637 }
883 item_provider_prepend { 638 item_provider_prepend {
884 /*@ 639 [[This prepends a custom item provider to the list for that entry
885 This prepends a custom item provider to the list for that entry
886
887 This prepends the given callback. See elm_entry_item_provider_append() for
888 more information
889
890 @ingroup Entry */
891 640
641 This prepends the given callback.]]
892 params { 642 params {
893 @in func: Elm_Entry_Item_Provider_Cb; /*@ The function called to provide the item object */ 643 @in func: Elm_Entry_Item_Provider_Cb; [[The function called to provide the item object.]]
894 @in data: void * @optional; /*@ The data passed to $func */ 644 @in data: void * @optional; [[The data passed to $func.]]
895 } 645 }
896 } 646 }
897 input_panel_show { 647 input_panel_show {
898 /*@ 648 [[Show the input panel (virtual keyboard) based on the input panel property of entry such as layout, autocapital types, and so on.
899 Show the input panel (virtual keyboard) based on the input panel property of entry such as layout, autocapital types, and so on.
900
901 Note that input panel is shown or hidden automatically according to the focus state of entry widget.
902 This API can be used in the case of manually controlling by using elm_entry_input_panel_enabled_set(en, false).
903
904 @ingroup Entry */
905 649
650 Note that input panel is shown or hidden automatically according to the focus state of entry widget.
651 This API can be used in the case of manually controlling by using @.input_panel_enabled.set(en, $false).
652 ]]
906 } 653 }
907 imf_context_reset { 654 imf_context_reset {
908 /*@ 655 [[Reset the input method context of the entry if needed.
909 Reset the input method context of the entry if needed.
910
911 This can be necessary in the case where modifying the buffer would confuse on-going input method behavior.
912 This will typically cause the Input Method Context to clear the preedit state.
913 @ingroup Entry */
914 656
657 This can be necessary in the case where modifying the buffer would confuse on-going input method behavior.
658 This will typically cause the Input Method Context to clear the preedit state.
659 ]]
915 } 660 }
916 calc_force { 661 calc_force {
917 /*@ 662 [[Forces calculation of the entry size and text layouting.
918 Forces calculation of the entry size and text layouting.
919
920 This should be used after modifying the textblock object directly. See
921 elm_entry_textblock_get() for more information.
922
923 @see elm_entry_textblock_get()
924
925 @ingroup Entry */
926 663
664 This should be used after modifying the textblock object directly. See
665 @.textblock.get for more information.
666 ]]
927 } 667 }
928 anchor_hover_end { 668 anchor_hover_end {
929 /*@ 669 [[Ends the hover popup in the entry
930 Ends the hover popup in the entry
931
932 When an anchor is clicked, the entry widget will create a hover
933 object to use as a popup with user provided content. This function
934 terminates this popup, returning the entry to its normal state.
935
936 @ingroup Entry */
937 670
671 When an anchor is clicked, the entry widget will create a hover
672 object to use as a popup with user provided content. This function
673 terminates this popup, returning the entry to its normal state.
674 ]]
938 } 675 }
939 cursor_selection_begin { 676 cursor_selection_begin {
940 /*@ 677 [[This begins a selection within the entry as though
941 This begins a selection within the entry as though 678 the user were holding down the mouse button to make a selection.]]
942 the user were holding down the mouse button to make a selection.
943
944 @ingroup Entry */
945
946 } 679 }
947 cursor_down { 680 cursor_down {
948 /*@ 681 [[This moves the cursor one line down within the entry.]]
949 This moves the cursor one line down within the entry.
950
951 @return true upon success, false upon failure
952
953 @ingroup Entry */
954
955 return: bool; 682 return: bool;
956 } 683 }
957 file_save { 684 file_save {
958 /*@ 685 [[This function writes any changes made to the file set with
959 This function writes any changes made to the file set with 686 \@ref elm_entry_file_set.]]
960 elm_entry_file_set()
961
962 @ingroup Entry */
963
964 } 687 }
965 selection_copy { 688 selection_copy {
966 /*@ 689 [[This executes a "copy" action on the selected text in the entry.]]
967 This executes a "copy" action on the selected text in the entry.
968
969 @ingroup Entry */
970
971 } 690 }
972 text_style_user_push { 691 text_style_user_push {
973 /*@ 692 [[Push the style to the top of user style stack.
974 Push the style to the top of user style stack. 693 If there is styles in the user style stack, the properties in the top style
975 If there is styles in the user style stack, the properties in the top style 694 of user style stack will replace the properties in current theme.
976 of user style stack will replace the properties in current theme. 695 The input style is specified in format tag='property=value' (i.e. DEFAULT='font=Sans font_size=60'hilight=' + font_weight=Bold').
977 The input style is specified in format tag='property=value' (i.e. DEFAULT='font=Sans font_size=60'hilight=' + font_weight=Bold').
978
979 @ingroup Entry
980 @since 1.7 */
981 696
697 @since 1.7
698 ]]
982 params { 699 params {
983 @in style: const(char)*; /*@ The style user to push */ 700 @in style: const(char)*; [[The style user to push.]]
984 } 701 }
985 } 702 }
986 item_provider_remove { 703 item_provider_remove {
987 /*@ 704 [[This removes a custom item provider to the list for that entry
988 This removes a custom item provider to the list for that entry
989
990 This removes the given callback. See elm_entry_item_provider_append() for
991 more information
992
993 @ingroup Entry */
994 705
706 This removes the given callback. See @.item_provider_append for
707 more information
708 ]]
995 params { 709 params {
996 @in func: Elm_Entry_Item_Provider_Cb; /*@ The function called to provide the item object */ 710 @in func: Elm_Entry_Item_Provider_Cb; [[The function called to provide the item object.]]
997 @in data: void * @optional; /*@ The data passed to $func */ 711 @in data: void * @optional; [[The data passed to $func.]]
998 } 712 }
999 } 713 }
1000 text_style_user_peek @const { 714 text_style_user_peek @const {
1001 /*@ 715 [[Get the style on the top of user style stack.
1002 Get the style on the top of user style stack.
1003 716
1004 @return style on the top of user style stack if exist, otherwise NULL. 717 See also @.text_style_user_push.
1005 718
1006 @see elm_entry_text_style_user_push() 719 @since 1.7
1007 720 ]]
1008 @ingroup Entry
1009 @since 1.7 */
1010 return: const(char)*; 721 return: const(char)*;
1011 } 722 }
1012 context_menu_clear { 723 context_menu_clear {
1013 /*@ 724 [[This clears and frees the items in a entry's contextual (longpress)
1014 This clears and frees the items in a entry's contextual (longpress) 725 menu.
1015 menu.
1016
1017 @see elm_entry_context_menu_item_add()
1018
1019 @ingroup Entry */
1020 726
727 See also @.context_menu_item_add.
728 ]]
1021 } 729 }
1022 cursor_up { 730 cursor_up {
1023 /*@ 731 [[This moves the cursor one line up within the entry.]]
1024 This moves the cursor one line up within the entry.
1025
1026 @return true upon success, false upon failure
1027
1028 @ingroup Entry */
1029
1030 return: bool; 732 return: bool;
1031 } 733 }
1032 entry_insert { 734 entry_insert {
1033 /*@ 735 [[Inserts the given text into the entry at the current cursor position.
1034 Inserts the given text into the entry at the current cursor position.
1035
1036 This inserts text at the cursor position as if it was typed
1037 by the user (note that this also allows markup which a user
1038 can't just "type" as it would be converted to escaped text, so this
1039 call can be used to insert things like emoticon items or bold push/pop
1040 tags, other font and color change tags etc.)
1041 736
1042 If any selection exists, it will be replaced by the inserted text. 737 This inserts text at the cursor position as if it was typed
738 by the user (note that this also allows markup which a user
739 can't just "type" as it would be converted to escaped text, so this
740 call can be used to insert things like emoticon items or bold push/pop
741 tags, other font and color change tags etc.)
1043 742
1044 The inserted text is subject to any filters set for the widget. 743 If any selection exists, it will be replaced by the inserted text.
1045 744
1046 @see elm_entry_markup_filter_append() 745 The inserted text is subject to any filters set for the widget.
1047
1048 @ingroup Entry */
1049 746
747 See also @.markup_filter_append.
748 ]]
1050 params { 749 params {
1051 @in entry: const(char)*; /*@ The text to insert */ 750 @in entry: const(char)*; [[The text to insert.]]
1052 } 751 }
1053 } 752 }
1054 input_panel_imdata_set { 753 input_panel_imdata_set {
1055 /*@ 754 [[Set the input panel-specific data to deliver to the input panel.
1056 Set the input panel-specific data to deliver to the input panel.
1057
1058 This API is used by applications to deliver specific data to the input panel.
1059 The data format MUST be negotiated by both application and the input panel.
1060 The size and format of data are defined by the input panel.
1061
1062 @ingroup Entry */
1063 755
756 This API is used by applications to deliver specific data to the input panel.
757 The data format MUST be negotiated by both application and the input panel.
758 The size and format of data are defined by the input panel.
759 ]]
1064 params { 760 params {
1065 @in data: const(void)*; /*@ The specific data to be set to the input panel. */ 761 @in data: const(void)*; [[The specific data to be set to the input panel.]]
1066 @in len: int; /*@ the length of data, in bytes, to send to the input panel */ 762 @in len: int; [[The length of data, in bytes, to send to the input panel.]]
1067 } 763 }
1068 } 764 }
1069 input_panel_imdata_get @const { 765 input_panel_imdata_get @const {
1070 /*@ 766 [[Get the specific data of the current input panel.]]
1071 Get the specific data of the current input panel.
1072
1073 See @ref elm_entry_input_panel_imdata_set for more details.
1074
1075 @ingroup Entry */
1076 params { 767 params {
1077 @out data: void; /*@ The specific data to be got from the input panel */ 768 @out data: void; [[The specific data to be got from the input panel.]]
1078 @out len: int; /*@ The length of data */ 769 @out len: int; [[The length of data.]]
1079 } 770 }
1080 } 771 }
1081 selection_paste { 772 selection_paste {
1082 /*@ 773 [[This executes a "paste" action in the entry.]]
1083 This executes a "paste" action in the entry.
1084
1085 @ingroup Entry */
1086
1087 } 774 }
1088 cursor_next { 775 cursor_next {
1089 /*@ 776 [[This moves the cursor one place to the right within the entry.]]
1090 This moves the cursor one place to the right within the entry.
1091
1092 @return true upon success, false upon failure
1093
1094 @ingroup Entry */
1095
1096 return: bool; 777 return: bool;
1097 } 778 }
1098 select_none { 779 select_none {
1099 /*@ 780 [[This drops any existing text selection within the entry.]]
1100 This drops any existing text selection within the entry.
1101
1102 @ingroup Entry */
1103
1104 } 781 }
1105 input_panel_hide { 782 input_panel_hide {
1106 /*@ 783 [[Hide the input panel (virtual keyboard).
1107 Hide the input panel (virtual keyboard).
1108
1109 Note that input panel is shown or hidden automatically according to the focus state of entry widget.
1110 This API can be used in the case of manually controlling by using elm_entry_input_panel_enabled_set(en, false)
1111
1112 @ingroup Entry */
1113 784
785 Note that input panel is shown or hidden automatically according to the focus state of entry widget.
786 This API can be used in the case of manually controlling by using @.input_panel_enabled.set(en, $false)
787 ]]
1114 } 788 }
1115 select_all { 789 select_all {
1116 /*@ 790 [[This selects all text within the entry.]]
1117 This selects all text within the entry.
1118
1119 @ingroup Entry */
1120
1121 } 791 }
1122 cursor_selection_end { 792 cursor_selection_end {
1123 /*@ 793 [[This ends a selection within the entry as though
1124 This ends a selection within the entry as though 794 the user had just released the mouse button while making a selection.]]
1125 the user had just released the mouse button while making a selection.
1126
1127 @ingroup Entry */
1128
1129 } 795 }
1130 selection_cut { 796 selection_cut {
1131 /*@ 797 [[This executes a "cut" action on the selected text in the entry.]]
1132 This executes a "cut" action on the selected text in the entry.
1133
1134 @ingroup Entry */
1135
1136 } 798 }
1137 is_empty @const { 799 is_empty @const {
1138 /*@ 800 [[Get whether the entry is empty.
1139 Get whether the entry is empty.
1140
1141 Empty means no text at all. If there are any markup tags, like an item
1142 tag for which no provider finds anything, and no text is displayed, this
1143 function still returns false.
1144 801
1145 @return $true if the entry text is empty or $entry is NULL, $false otherwise. 802 Empty means no text at all. If there are any markup tags, like an item
1146 803 tag for which no provider finds anything, and no text is displayed, this
1147 @ingroup Entry */ 804 function still returns $false.
805 ]]
1148 return: bool(true); 806 return: bool(true);
1149 } 807 }
1150 markup_filter_remove { 808 markup_filter_remove {
1151 /*@ 809 [[Remove a markup filter from the list
1152 Remove a markup filter from the list
1153
1154 Removes the given callback from the filter list. See
1155 elm_entry_markup_filter_append() for more information.
1156
1157 @ingroup Entry */
1158 810
811 Removes the given callback from the filter list. See
812 @.markup_filter_append for more information.
813 ]]
1159 params { 814 params {
1160 @in func: Elm_Entry_Filter_Cb; /*@ The filter function to remove */ 815 @in func: Elm_Entry_Filter_Cb; [[The filter function to remove.]]
1161 @in data: void * @optional; /*@ The user data passed when adding the function */ 816 @in data: void * @optional; [[The user data passed when adding the function.]]
1162 } 817 }
1163 } 818 }
1164 item_provider_append { 819 item_provider_append {
1165 /*@ 820 [[This appends a custom item provider to the list for that entry
1166 This appends a custom item provider to the list for that entry
1167
1168 This appends the given callback. The list is walked from beginning to end
1169 with each function called given the item href string in the text. If the
1170 function returns an object handle other than NULL (it should create an
1171 object to do this), then this object is used to replace that item. If
1172 not the next provider is called until one provides an item object, or the
1173 default provider in entry does.
1174 821
1175 @see @ref entry-items 822 This appends the given callback. The list is walked from beginning to end
1176 823 with each function called given the item href string in the text. If the
1177 @ingroup Entry */ 824 function returns an object handle other than $null (it should create an
825 object to do this), then this object is used to replace that item. If
826 not the next provider is called until one provides an item object, or the
827 default provider in entry does.
1178 828
829 See also \@ref entry-items.
830 ]]
1179 params { 831 params {
1180 @in func: Elm_Entry_Item_Provider_Cb; /*@ The function called to provide the item object */ 832 @in func: Elm_Entry_Item_Provider_Cb; [[The function called to provide the item object.]]
1181 @in data: void * @optional; /*@ The data passed to $func */ 833 @in data: void * @optional; [[The data passed to $func.]]
1182 } 834 }
1183 } 835 }
1184 markup_filter_append { 836 markup_filter_append {
1185 /*@ 837 [[Append a markup filter function for text inserted in the entry
1186 Append a markup filter function for text inserted in the entry 838
1187 839 Append the given callback to the list. This functions will be called
1188 Append the given callback to the list. This functions will be called 840 whenever any text is inserted into the entry, with the text to be inserted
1189 whenever any text is inserted into the entry, with the text to be inserted 841 as a parameter. The type of given text is always markup.
1190 as a parameter. The type of given text is always markup. 842 The callback function is free to alter the text in any way it wants, but
1191 The callback function is free to alter the text in any way it wants, but 843 it must remember to free the given pointer and update it.
1192 it must remember to free the given pointer and update it. 844 If the new text is to be discarded, the function can free it and set its
1193 If the new text is to be discarded, the function can free it and set its 845 text parameter to $null. This will also prevent any following filters from
1194 text parameter to NULL. This will also prevent any following filters from 846 being called.
1195 being called. 847 ]]
1196
1197 @ingroup Entry */
1198
1199 params { 848 params {
1200 @in func: Elm_Entry_Filter_Cb; /*@ The function to use as text filter */ 849 @in func: Elm_Entry_Filter_Cb; [[The function to use as text filter.]]
1201 @in data: void * @optional; /*@ User data to pass to $func */ 850 @in data: void * @optional; [[User data to pass to $func.]]
1202 } 851 }
1203 } 852 }
1204 entry_append { 853 entry_append {
1205 /*@ 854 [[Appends $str to the text of the entry.
1206 Appends $str to the text of the entry.
1207 855
1208 Adds the text in $str to the end of any text already present in the 856 Adds the text in $str to the end of any text already present in the
1209 widget. 857 widget.
1210 858
1211 The appended text is subject to any filters set for the widget. 859 The appended text is subject to any filters set for the widget.
1212
1213 @see elm_entry_markup_filter_append()
1214
1215 @ingroup Entry */
1216 860
861 See also @.markup_filter_append.
862 ]]
1217 params { 863 params {
1218 @in str: const(char)*; /*@ The text to be appended */ 864 @in str: const(char)*; [[The text to be appended.]]
1219 } 865 }
1220 } 866 }
1221 context_menu_item_add { 867 context_menu_item_add {
1222 /*@ 868 [[This adds an item to the entry's contextual menu.
1223 This adds an item to the entry's contextual menu.
1224 869
1225 A longpress on an entry will make the contextual menu show up, if this 870 A longpress on an entry will make the contextual menu show up, if this
1226 hasn't been disabled with elm_entry_context_menu_disabled_set(). 871 hasn't been disabled with @.context_menu_disabled.set.
1227 By default, this menu provides a few options like enabling selection mode, 872 By default, this menu provides a few options like enabling selection mode,
1228 which is useful on embedded devices that need to be explicit about it, 873 which is useful on embedded devices that need to be explicit about it,
1229 and when a selection exists it also shows the copy and cut actions. 874 and when a selection exists it also shows the copy and cut actions.
1230
1231 With this function, developers can add other options to this menu to
1232 perform any action they deem necessary.
1233
1234 @ingroup Entry */
1235 875
876 With this function, developers can add other options to this menu to
877 perform any action they deem necessary.
878 ]]
1236 params { 879 params {
1237 @in label: const(char)* @optional; /*@ The item's text label */ 880 @in label: const(char)* @optional; [[The item's text label.]]
1238 @in icon_file: const(char)* @optional; /*@ The item's icon file */ 881 @in icon_file: const(char)* @optional; [[The item's icon file.]]
1239 @in icon_type: Elm_Icon_Type; /*@ The item's icon type */ 882 @in icon_type: Elm_Icon_Type; [[The item's icon type.]]
1240 @in func: Evas_Smart_Cb @optional; /*@ The callback to execute when the item is clicked */ 883 @in func: Evas_Smart_Cb @optional; [[The callback to execute when the item is clicked.]]
1241 @in data: const(void)* @optional; /*@ The data to associate with the item for related functions */ 884 @in data: const(void)* @optional; [[The data to associate with the item for related functions.]]
1242 } 885 }
1243 } 886 }
1244 markup_filter_prepend { 887 markup_filter_prepend {
1245 /*@ 888 [[Prepend a markup filter function for text inserted in the entry
1246 Prepend a markup filter function for text inserted in the entry
1247
1248 Prepend the given callback to the list. See elm_entry_markup_filter_append()
1249 for more information
1250
1251 @ingroup Entry */
1252 889
890 Prepend the given callback to the list.]]
1253 params { 891 params {
1254 @in func: Elm_Entry_Filter_Cb; /*@ The function to use as text filter */ 892 @in func: Elm_Entry_Filter_Cb; [[The function to use as text filter.]]
1255 @in data: void * @optional; /*@ User data to pass to $func */ 893 @in data: void * @optional; [[User data to pass to $func.]]
1256 } 894 }
1257 } 895 }
1258 } 896 }