2 * vim:ts=8:sw=3:sts=8:noexpandtab:cino=>5n-3f0^-2{2
4 #include <Elementary.h>
8 * @defgroup Scrolled_Entry Scrolled_Entry
11 * A scrolled entry is a convenience widget which shows
12 * a box that the user can enter text into. Unlike an
13 * @ref Entry widget, scrolled entries scroll with user
14 * input so that the window will not expand if the length
15 * of text inside the entry exceeds the initial size of the
18 * Signals that you can add callbacks for are:
19 * - "changed" - The text within the entry was changed
20 * - "activated" - The entry has received focus and the cursor
21 * - "press" - The entry has been clicked
22 * - "longpressed" - The entry has been clicked for a couple seconds
23 * - "clicked" - The entry has been clicked
24 * - "clicked,double" - The entry has been double clicked
25 * - "focused" - The entry has received focus
26 * - "unfocused" - The entry has lost focus
27 * - "selection,paste" - A paste action has occurred
28 * - "selection,copy" - A copy action has occurred
29 * - "selection,cut" - A cut action has occurred
30 * - "selection,start" - A selection has begun
31 * - "selection,changed" - The selection has changed
32 * - "selection,cleared" - The selection has been cleared
33 * - "cursor,changed" - The cursor has changed
34 * - "anchor,clicked" - The anchor has been clicked
37 typedef struct _Widget_Data Widget_Data;
41 Evas_Object *scroller;
43 Elm_Scroller_Policy policy_h, policy_v;
44 Eina_Bool single_line : 1;
47 static const char *widtype = NULL;
49 static const char SIG_CHANGED[] = "changed";
50 static const char SIG_ACTIVATED[] = "activated";
51 static const char SIG_PRESS[] = "press";
52 static const char SIG_LONGPRESSED[] = "longpressed";
53 static const char SIG_CLICKED[] = "clicked";
54 static const char SIG_CLICKED_DOUBLE[] = "clicked,double";
55 static const char SIG_FOCUSED[] = "focused";
56 static const char SIG_UNFOCUSED[] = "unfocused";
57 static const char SIG_SELECTION_PASTE[] = "selection,paste";
58 static const char SIG_SELECTION_COPY[] = "selection,copy";
59 static const char SIG_SELECTION_CUT[] = "selection,cut";
60 static const char SIG_SELECTION_START[] = "selection,start";
61 static const char SIG_SELECTION_CHANGED[] = "selection,changed";
62 static const char SIG_SELECTION_CLEARED[] = "selection,cleared";
63 static const char SIG_CURSOR_CHANGED[] = "cursor,changed";
64 static const char SIG_ANCHOR_CLICKED[] = "anchor,clicked";
65 static const Evas_Smart_Cb_Description _signals[] = {
69 {SIG_LONGPRESSED, ""},
71 {SIG_CLICKED_DOUBLE, ""},
74 {SIG_SELECTION_PASTE, ""},
75 {SIG_SELECTION_COPY, ""},
76 {SIG_SELECTION_CUT, ""},
77 {SIG_SELECTION_START, ""},
78 {SIG_SELECTION_CHANGED, ""},
79 {SIG_SELECTION_CLEARED, ""},
80 {SIG_CURSOR_CHANGED, ""},
81 {SIG_ANCHOR_CLICKED, ""},
86 _del_hook(Evas_Object *obj)
88 Widget_Data *wd = elm_widget_data_get(obj);
94 _theme_hook(Evas_Object *obj)
96 Widget_Data *wd = elm_widget_data_get(obj);
98 elm_object_style_set(wd->entry, elm_widget_style_get(obj));
99 elm_object_style_set(wd->scroller, elm_widget_style_get(obj));
103 _sizing_eval(Evas_Object *obj)
105 Widget_Data *wd = elm_widget_data_get(obj);
106 Evas_Coord minw, minh, minw_scr, minh_scr;
109 evas_object_size_hint_min_get(obj, &minw, &minh);
110 evas_object_size_hint_min_get(wd->scroller, &minw_scr, &minh_scr);
111 if (minw < minw_scr) minw = minw_scr;
112 if (minh < minh_scr) minh = minh_scr;
114 evas_object_size_hint_min_set(obj, minw, minh);
117 evas_object_size_hint_max_set(obj, -1, minh);
119 evas_object_size_hint_max_set(obj, -1, -1);
123 _on_focus_hook(void *data __UNUSED__, Evas_Object *obj)
125 Widget_Data *wd = elm_widget_data_get(obj);
127 if (elm_widget_focus_get(obj))
128 elm_widget_focus_steal(wd->entry);
132 _disable_hook(Evas_Object *obj)
134 Widget_Data *wd = elm_widget_data_get(obj);
136 elm_object_disabled_set(wd->entry, elm_widget_disabled_get(obj));
140 _signal_emit_hook(Evas_Object *obj, const char *emission, const char *source)
142 Widget_Data *wd = elm_widget_data_get(obj);
144 elm_object_signal_emit(wd->entry, emission, source);
145 elm_object_signal_emit(wd->scroller, emission, source);
149 _entry_changed(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
152 evas_object_smart_callback_call(data, SIG_CHANGED, NULL);
156 _entry_activated(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
158 evas_object_smart_callback_call(data, SIG_ACTIVATED, NULL);
162 _entry_press(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
164 evas_object_smart_callback_call(data, SIG_PRESS, NULL);
168 _entry_clicked(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
170 evas_object_smart_callback_call(data, SIG_CLICKED, NULL);
174 _entry_clicked_double(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
176 evas_object_smart_callback_call(data, SIG_CLICKED_DOUBLE, NULL);
180 _entry_cursor_changed(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
182 evas_object_smart_callback_call(data, SIG_CURSOR_CHANGED, NULL);
186 _entry_anchor_clicked(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
188 evas_object_smart_callback_call(data, SIG_ANCHOR_CLICKED, NULL);
192 _entry_selection_start(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
194 evas_object_smart_callback_call(data, SIG_SELECTION_START, NULL);
198 _entry_selection_changed(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
200 evas_object_smart_callback_call(data, SIG_SELECTION_CHANGED, NULL);
204 _entry_selection_cleared(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
206 evas_object_smart_callback_call(data, SIG_SELECTION_CLEARED, NULL);
210 _entry_selection_paste(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
212 evas_object_smart_callback_call(data, SIG_SELECTION_PASTE, NULL);
216 _entry_selection_copy(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
218 evas_object_smart_callback_call(data, SIG_SELECTION_COPY, NULL);
222 _entry_selection_cut(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
224 evas_object_smart_callback_call(data, SIG_SELECTION_CUT, NULL);
228 _entry_longpressed(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
230 evas_object_smart_callback_call(data, SIG_LONGPRESSED, NULL);
234 _entry_focused(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
236 evas_object_smart_callback_call(data, SIG_FOCUSED, NULL);
240 _entry_unfocused(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
242 evas_object_smart_callback_call(data, SIG_UNFOCUSED, NULL);
246 _entry_maxlength_reached(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
248 evas_object_smart_callback_call(data, "maxlength,reached", NULL);
253 * This adds a scrolled entry to @p parent object.
255 * @param parent The parent object
256 * @return The new object or NULL if it cannot be created
258 * @ingroup Scrolled_Entry
261 elm_scrolled_entry_add(Evas_Object *parent)
267 wd = ELM_NEW(Widget_Data);
268 e = evas_object_evas_get(parent);
269 obj = elm_widget_add(e);
270 ELM_SET_WIDTYPE(widtype, "scrolled_entry");
271 elm_widget_type_set(obj, "scrolled_entry");
272 elm_widget_sub_object_add(parent, obj);
273 elm_widget_on_focus_hook_set(obj, _on_focus_hook, NULL);
274 elm_widget_data_set(obj, wd);
275 elm_widget_del_hook_set(obj, _del_hook);
276 elm_widget_disable_hook_set(obj, _disable_hook);
277 elm_widget_can_focus_set(obj, 1);
278 elm_widget_theme_hook_set(obj, _theme_hook);
279 elm_widget_signal_emit_hook_set(obj, _signal_emit_hook);
281 wd->scroller = elm_scroller_add(parent);
282 elm_widget_sub_object_add(obj, wd->scroller);
283 elm_widget_resize_object_set(obj, wd->scroller);
284 elm_scroller_bounce_set(wd->scroller, 0, 0);
285 elm_scroller_propagate_events_set(wd->scroller, 1);
287 wd->entry = elm_entry_add(parent);
288 evas_object_size_hint_weight_set(wd->entry, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
289 evas_object_size_hint_align_set(wd->entry, EVAS_HINT_FILL, EVAS_HINT_FILL);
290 elm_scroller_content_set(wd->scroller, wd->entry);
291 evas_object_show(wd->entry);
293 evas_object_smart_callback_add(wd->entry, "changed", _entry_changed, obj);
294 evas_object_smart_callback_add(wd->entry, "activated", _entry_activated, obj);
295 evas_object_smart_callback_add(wd->entry, "press", _entry_press, obj);
296 evas_object_smart_callback_add(wd->entry, "clicked", _entry_clicked, obj);
297 evas_object_smart_callback_add(wd->entry, "clicked,double", _entry_clicked_double, obj);
298 evas_object_smart_callback_add(wd->entry, "cursor,changed", _entry_cursor_changed, obj);
299 evas_object_smart_callback_add(wd->entry, "anchor,clicked", _entry_anchor_clicked, obj);
300 evas_object_smart_callback_add(wd->entry, "selection,start", _entry_selection_start, obj);
301 evas_object_smart_callback_add(wd->entry, "selection,changed", _entry_selection_changed, obj);
302 evas_object_smart_callback_add(wd->entry, "selection,cleared", _entry_selection_cleared, obj);
303 evas_object_smart_callback_add(wd->entry, "selection,paste", _entry_selection_paste, obj);
304 evas_object_smart_callback_add(wd->entry, "selection,copy", _entry_selection_copy, obj);
305 evas_object_smart_callback_add(wd->entry, "selection,cut", _entry_selection_cut, obj);
306 evas_object_smart_callback_add(wd->entry, "longpressed", _entry_longpressed, obj);
307 evas_object_smart_callback_add(wd->entry, "focused", _entry_focused, obj);
308 evas_object_smart_callback_add(wd->entry, "unfocused", _entry_unfocused, obj);
309 evas_object_smart_callback_add(wd->entry, "maxlength,reached", _entry_maxlength_reached, obj);
313 // TODO: convert Elementary to subclassing of Evas_Smart_Class
314 // TODO: and save some bytes, making descriptions per-class and not instance!
315 evas_object_smart_callbacks_descriptions_set(obj, _signals);
320 * This sets the scrolled entry object not to line wrap. All input will
321 * be on a single line, and the entry box will scroll with user input.
323 * @param obj The scrolled entry object
324 * @param single_line If true, the text in the scrolled entry
325 * will be on a single line.
327 * @ingroup Scrolled_Entry
330 elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line)
332 ELM_CHECK_WIDTYPE(obj, widtype);
333 Widget_Data *wd = elm_widget_data_get(obj);
335 if (wd->single_line == single_line) return;
336 elm_entry_single_line_set(wd->entry, single_line);
337 wd->single_line = single_line;
340 elm_scroller_policy_set(wd->scroller, ELM_SCROLLER_POLICY_OFF, ELM_SCROLLER_POLICY_OFF);
341 elm_scroller_content_min_limit(wd->scroller, 0, 1);
345 elm_scroller_policy_set(wd->scroller, wd->policy_h, wd->policy_v);
346 elm_scroller_content_min_limit(wd->scroller, 0, 0);
352 * This returns true if the scrolled entry has been set to single line mode.
353 * See also elm_scrolled_entry_single_line_set().
355 * @param obj The scrolled entry object
356 * @return single_line If true, the text in the scrolled entry is set to display
359 * @ingroup Scrolled_Entry
362 elm_scrolled_entry_single_line_get(const Evas_Object *obj)
364 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
365 Widget_Data *wd = elm_widget_data_get(obj);
366 if (!wd) return EINA_FALSE;
367 return elm_entry_single_line_get(wd->entry);
371 * This sets the scrolled entry object to password mode. All text entered
372 * and/or displayed within the widget will be replaced with asterisks (*).
374 * @param obj The scrolled entry object
375 * @param password If true, password mode is enabled.
377 * @ingroup Scrolled_Entry
380 elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password)
382 ELM_CHECK_WIDTYPE(obj, widtype);
383 Widget_Data *wd = elm_widget_data_get(obj);
385 elm_entry_password_set(wd->entry, password);
389 * This returns whether password mode is enabled.
390 * See also elm_scrolled_entry_password_set().
392 * @param obj The scrolled entry object
393 * @return If true, the scrolled entry is set to display all characters
396 * @ingroup Scrolled_Entry
399 elm_scrolled_entry_password_get(const Evas_Object *obj)
401 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
402 Widget_Data *wd = elm_widget_data_get(obj);
403 if (!wd) return EINA_FALSE;
404 return elm_entry_password_get(wd->entry);
408 * This sets the text displayed within the scrolled entry to @p entry.
410 * @param obj The scrolled entry object
411 * @param entry The text to be displayed
413 * @ingroup Scrolled_Entry
416 elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry)
418 ELM_CHECK_WIDTYPE(obj, widtype);
419 Widget_Data *wd = elm_widget_data_get(obj);
421 elm_entry_entry_set(wd->entry, entry);
425 * This returns the text currently shown in object @p entry.
426 * See also elm_scrolled_entry_entry_set().
428 * @param obj The scrolled entry object
429 * @return The currently displayed text or NULL on failure
431 * @ingroup Scrolled_Entry
434 elm_scrolled_entry_entry_get(const Evas_Object *obj)
436 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
437 Widget_Data *wd = elm_widget_data_get(obj);
438 if (!wd) return NULL;
439 return elm_entry_entry_get(wd->entry);
443 * This returns all selected text within the scrolled entry.
445 * @param obj The scrolled entry object
446 * @return The selected text within the scrolled entry or NULL on failure
448 * @ingroup Scrolled_Entry
451 elm_scrolled_entry_selection_get(const Evas_Object *obj)
453 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
454 Widget_Data *wd = elm_widget_data_get(obj);
455 if (!wd) return NULL;
456 return elm_entry_selection_get(wd->entry);
460 * This inserts text in @p entry at the beginning of the scrolled entry
463 * @param obj The scrolled entry object
464 * @param entry The text to insert
466 * @ingroup Scrolled_Entry
469 elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry)
471 ELM_CHECK_WIDTYPE(obj, widtype);
472 Widget_Data *wd = elm_widget_data_get(obj);
474 elm_entry_entry_insert(wd->entry, entry);
478 * This enables word line wrapping in the scrolled entry object. It is the opposite
479 * of elm_scrolled_entry_single_line_set(). Additionally, setting this disables
480 * character line wrapping.
481 * See also elm_scrolled_entry_line_char_wrap_set().
483 * @param obj The scrolled entry object
484 * @param wrap If true, the scrolled entry will be wrapped once it reaches the end
485 * of the object. Wrapping will occur at the end of the word before the end of the
488 * @ingroup Scrolled_Entry
491 elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Eina_Bool wrap)
493 ELM_CHECK_WIDTYPE(obj, widtype);
494 Widget_Data *wd = elm_widget_data_get(obj);
496 elm_entry_line_wrap_set(wd->entry, wrap);
500 * This enables character line wrapping in the scrolled entry object. It is the opposite
501 * of elm_scrolled_entry_single_line_set(). Additionally, setting this disables
502 * word line wrapping.
503 * See also elm_scrolled_entry_line_wrap_set().
505 * @param obj The scrolled entry object
506 * @param wrap If true, the scrolled entry will be wrapped once it reaches the end
507 * of the object. Wrapping will occur immediately upon reaching the end of the object.
509 * @ingroup Scrolled_Entry
512 elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap)
514 ELM_CHECK_WIDTYPE(obj, widtype);
515 Widget_Data *wd = elm_widget_data_get(obj);
517 elm_entry_line_char_wrap_set(wd->entry, wrap);
521 * This sets the editable attribute of the scrolled entry.
523 * @param obj The scrolled entry object
524 * @param editable If true, the scrolled entry will be editable by the user.
525 * If false, it will be set to the disabled state.
527 * @ingroup Scrolled_Entry
530 elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable)
532 ELM_CHECK_WIDTYPE(obj, widtype);
533 Widget_Data *wd = elm_widget_data_get(obj);
535 elm_entry_editable_set(wd->entry, editable);
539 * This gets the editable attribute of the scrolled entry.
540 * See also elm_scrolled_entry_editable_set().
542 * @param obj The scrolled entry object
543 * @return If true, the scrolled entry is editable by the user.
544 * If false, it is not editable by the user
546 * @ingroup Scrolled_Entry
549 elm_scrolled_entry_editable_get(const Evas_Object *obj)
551 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
552 Widget_Data *wd = elm_widget_data_get(obj);
553 if (!wd) return EINA_FALSE;
554 return elm_entry_editable_get(wd->entry);
558 * This drops any existing text selection within the scrolled entry.
560 * @param obj The scrolled entry object
562 * @ingroup Scrolled_Entry
565 elm_scrolled_entry_select_none(Evas_Object *obj)
567 ELM_CHECK_WIDTYPE(obj, widtype);
568 Widget_Data *wd = elm_widget_data_get(obj);
570 elm_entry_select_none(wd->entry);
574 * This selects all text within the scrolled entry.
576 * @param obj The scrolled entry object
578 * @ingroup Scrolled_Entry
581 elm_scrolled_entry_select_all(Evas_Object *obj)
583 ELM_CHECK_WIDTYPE(obj, widtype);
584 Widget_Data *wd = elm_widget_data_get(obj);
586 elm_entry_select_all(wd->entry);
590 * This moves the cursor one place to the right within the entry.
592 * @param obj The scrolled entry object
593 * @return EINA_TRUE upon success, EINA_FALSE upon failure
595 * @ingroup Scrolled_Entry
598 elm_scrolled_entry_cursor_next(Evas_Object *obj)
600 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
601 Widget_Data *wd = elm_widget_data_get(obj);
602 if (!wd) return EINA_FALSE;
603 return elm_entry_cursor_next(wd->entry);
607 * This moves the cursor one place to the left within the entry.
609 * @param obj The scrolled entry object
610 * @return EINA_TRUE upon success, EINA_FALSE upon failure
612 * @ingroup Scrolled_Entry
615 elm_scrolled_entry_cursor_prev(Evas_Object *obj)
617 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
618 Widget_Data *wd = elm_widget_data_get(obj);
619 if (!wd) return EINA_FALSE;
620 return elm_entry_cursor_prev(wd->entry);
624 * This moves the cursor one line up within the entry.
626 * @param obj The scrolled entry object
627 * @return EINA_TRUE upon success, EINA_FALSE upon failure
629 * @ingroup Scrolled_Entry
632 elm_scrolled_entry_cursor_up(Evas_Object *obj)
634 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
635 Widget_Data *wd = elm_widget_data_get(obj);
636 if (!wd) return EINA_FALSE;
637 return elm_entry_cursor_up(wd->entry);
641 * This moves the cursor one line down within the entry.
643 * @param obj The scrolled entry object
644 * @return EINA_TRUE upon success, EINA_FALSE upon failure
646 * @ingroup Scrolled_Entry
649 elm_scrolled_entry_cursor_down(Evas_Object *obj)
651 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
652 Widget_Data *wd = elm_widget_data_get(obj);
653 if (!wd) return EINA_FALSE;
654 return elm_entry_cursor_down(wd->entry);
658 * This moves the cursor to the beginning of the entry.
660 * @param obj The scrolled entry object
662 * @ingroup Scrolled_Entry
665 elm_scrolled_entry_cursor_begin_set(Evas_Object *obj)
667 ELM_CHECK_WIDTYPE(obj, widtype);
668 Widget_Data *wd = elm_widget_data_get(obj);
670 elm_entry_cursor_begin_set(wd->entry);
674 * This moves the cursor to the end of the entry.
676 * @param obj The scrolled entry object
678 * @ingroup Scrolled_Entry
681 elm_scrolled_entry_cursor_end_set(Evas_Object *obj)
683 ELM_CHECK_WIDTYPE(obj, widtype);
684 Widget_Data *wd = elm_widget_data_get(obj);
687 elm_scroller_region_get(wd->scroller, &x, &y, &w, &h);
688 elm_entry_cursor_end_set(wd->entry);
689 elm_scroller_region_show(wd->scroller, x, y, w, h);
693 * This moves the cursor to the beginning of the current line.
695 * @param obj The scrolled entry object
697 * @ingroup Scrolled_Entry
700 elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj)
702 ELM_CHECK_WIDTYPE(obj, widtype);
703 Widget_Data *wd = elm_widget_data_get(obj);
705 elm_entry_cursor_line_begin_set(wd->entry);
709 * This moves the cursor to the end of the current line.
711 * @param obj The scrolled entry object
713 * @ingroup Scrolled_Entry
716 elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj)
718 ELM_CHECK_WIDTYPE(obj, widtype);
719 Widget_Data *wd = elm_widget_data_get(obj);
721 elm_entry_cursor_line_end_set(wd->entry);
725 * This begins a selection within the scrolled entry as though
726 * the user were holding down the mouse button to make a selection.
728 * @param obj The scrolled entry object
730 * @ingroup Scrolled_Entry
733 elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj)
735 ELM_CHECK_WIDTYPE(obj, widtype);
736 Widget_Data *wd = elm_widget_data_get(obj);
738 elm_entry_cursor_selection_begin(wd->entry);
742 * This ends a selection within the scrolled entry as though
743 * the user had just released the mouse button while making a selection.
745 * @param obj The scrolled entry object
747 * @ingroup Scrolled_Entry
750 elm_scrolled_entry_cursor_selection_end(Evas_Object *obj)
752 ELM_CHECK_WIDTYPE(obj, widtype);
753 Widget_Data *wd = elm_widget_data_get(obj);
755 elm_entry_cursor_selection_end(wd->entry);
761 * @param obj The scrolled entry object
762 * @return TODO: fill this in
764 * @ingroup Scrolled_Entry
767 elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj)
769 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
770 Widget_Data *wd = elm_widget_data_get(obj);
771 if (!wd) return EINA_FALSE;
772 return elm_entry_cursor_is_format_get(wd->entry);
776 * This returns whether the cursor is visible.
778 * @param obj The scrolled entry object
779 * @return If true, the cursor is visible.
781 * @ingroup Scrolled_Entry
784 elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj)
786 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
787 Widget_Data *wd = elm_widget_data_get(obj);
788 if (!wd) return EINA_FALSE;
789 return elm_entry_cursor_is_visible_format_get(wd->entry);
795 * @param obj The scrolled entry object
796 * @return TODO: fill this in
798 * @ingroup Scrolled_Entry
801 elm_scrolled_entry_cursor_content_get(const Evas_Object *obj)
803 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
804 Widget_Data *wd = elm_widget_data_get(obj);
805 if (!wd) return NULL;
806 return elm_entry_cursor_content_get(wd->entry);
810 * This executes a "cut" action on the selected text in the scrolled entry.
812 * @param obj The scrolled entry object
814 * @ingroup Scrolled_Entry
817 elm_scrolled_entry_selection_cut(Evas_Object *obj)
819 ELM_CHECK_WIDTYPE(obj, widtype);
820 Widget_Data *wd = elm_widget_data_get(obj);
822 elm_entry_selection_cut(wd->entry);
826 * This executes a "copy" action on the selected text in the scrolled entry.
828 * @param obj The scrolled entry object
830 * @ingroup Scrolled_Entry
833 elm_scrolled_entry_selection_copy(Evas_Object *obj)
835 ELM_CHECK_WIDTYPE(obj, widtype);
836 Widget_Data *wd = elm_widget_data_get(obj);
838 elm_entry_selection_copy(wd->entry);
842 * This executes a "paste" action in the scrolled entry.
844 * @param obj The scrolled entry object
846 * @ingroup Scrolled_Entry
849 elm_scrolled_entry_selection_paste(Evas_Object *obj)
851 ELM_CHECK_WIDTYPE(obj, widtype);
852 Widget_Data *wd = elm_widget_data_get(obj);
854 elm_entry_selection_paste(wd->entry);
858 * This clears and frees the items in a scrolled entry's contextual (right click) menu.
860 * @param obj The scrolled entry object
862 * @ingroup Scrolled_Entry
865 elm_scrolled_entry_context_menu_clear(Evas_Object *obj)
867 ELM_CHECK_WIDTYPE(obj, widtype);
868 Widget_Data *wd = elm_widget_data_get(obj);
870 elm_entry_context_menu_clear(wd->entry);
874 * This adds an item to the scrolled entry's contextual menu.
876 * @param obj The scrolled entry object
877 * @param label The item's text label
878 * @param icon_file The item's icon file
879 * @param icon_type The item's icon type
880 * @param func The callback to execute when the item is clicked
881 * @param data The data to associate with the item for related functions
883 * @ingroup Scrolled_Entry
886 elm_scrolled_entry_context_menu_item_add(Evas_Object *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data)
888 ELM_CHECK_WIDTYPE(obj, widtype);
889 Widget_Data *wd = elm_widget_data_get(obj);
891 elm_entry_context_menu_item_add(wd->entry, label, icon_file, icon_type, func, data);
895 * This disables the scrolled entry's contextual (right click) menu.
897 * @param obj The scrolled entry object
898 * @param disabled If true, the menu is disabled
900 * @ingroup Scrolled_Entry
903 elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled)
905 ELM_CHECK_WIDTYPE(obj, widtype);
906 Widget_Data *wd = elm_widget_data_get(obj);
908 elm_entry_context_menu_disabled_set(wd->entry, disabled);
912 * This returns whether the scrolled entry's contextual (right click) menu is disabled.
914 * @param obj The scrolled entry object
915 * @return If true, the menu is disabled
917 * @ingroup Scrolled_Entry
920 elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj)
922 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
923 Widget_Data *wd = elm_widget_data_get(obj);
924 if (!wd) return EINA_FALSE;
925 return elm_entry_context_menu_disabled_get(wd->entry);
929 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling them).
931 * @param obj The scrolled entry object
932 * @param h The horizontal scrollbar policy to apply
933 * @param v The vertical scrollbar policy to apply
935 * @ingroup Scrolled_Entry
938 elm_scrolled_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v)
940 ELM_CHECK_WIDTYPE(obj, widtype);
941 Widget_Data *wd = elm_widget_data_get(obj);
945 elm_scroller_policy_set(wd->scroller, h, v);
949 * This enables/disables bouncing within the entry.
951 * @param obj The scrolled entry object
952 * @param h The horizontal bounce state
953 * @param v The vertical bounce state
955 * @ingroup Scrolled_Entry
958 elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce)
960 ELM_CHECK_WIDTYPE(obj, widtype);
961 Widget_Data *wd = elm_widget_data_get(obj);
963 elm_scroller_bounce_set(wd->scroller, h_bounce, v_bounce);
966 * This set's the maximum bytes that can be added in to scrolled entry.
968 * @param obj The scrolled entry object
969 * @param max_no_of_bytes Maximum number of bytes scrolled entry can have.
971 * @ingroup Scrolled_Entry
974 elm_scrolled_entry_maximum_bytes_set(Evas_Object *obj, int max_no_of_bytes)
976 ELM_CHECK_WIDTYPE(obj, widtype);
977 Widget_Data *wd = elm_widget_data_get(obj);
979 elm_entry_maximum_bytes_set(wd->entry,max_no_of_bytes);
983 * This set's the scrolled entry in password mode with out masking the last character entered by user,
984 * and later masking the character after 2 seconds.
986 * @param obj The scrolled entry object
987 * @param show_last_character The show_last_character flag (1 for "password mode along with showing last character"
990 * @ingroup Scrolled_Entry
993 elm_scrolled_entry_password_show_last_character_set(Evas_Object *obj, Eina_Bool show_last_character)
995 ELM_CHECK_WIDTYPE(obj, widtype);
996 Widget_Data *wd = elm_widget_data_get(obj);
998 elm_entry_password_show_last_character_set(wd->entry, show_last_character);
1002 * Get the input method context in the scrolled entry widget
1004 * @param obj The scrolled entry object
1005 * @return The input method context
1007 * @ingroup Scrolled_Entry
1009 EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj)
1011 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
1012 Widget_Data *wd = elm_widget_data_get(obj);
1013 if (!wd || !wd->entry) return NULL;
1015 return elm_entry_imf_context_get(wd->entry);
1019 * This sets the attribute to show the input panel automatically.
1021 * @param obj The scrolled entry object
1022 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
1024 * @ingroup Scrolled_Entry
1027 elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled)
1029 ELM_CHECK_WIDTYPE(obj, widtype);
1030 Widget_Data *wd = elm_widget_data_get(obj);
1031 if (!wd || !wd->entry) return;
1033 elm_entry_input_panel_enabled_set(wd->entry, enabled);
1037 * Set the input panel layout of the scrolled entry
1039 * @param obj The scrolled entry object
1040 * @param layout the layout to set
1042 * @ingroup Scrolled_Entry
1045 elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout)
1047 ELM_CHECK_WIDTYPE(obj, widtype);
1048 Widget_Data *wd = elm_widget_data_get(obj);
1049 if (!wd || !wd->entry) return;
1051 elm_entry_input_panel_layout_set(wd->entry, layout);
1055 * Set whether scrolled entry should support auto capitalization
1057 * @param obj The entry object
1058 * @param on If true, scrolled entry suports auto capitalization.
1060 * @ingroup Scrolled_Entry
1063 elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap)
1065 ELM_CHECK_WIDTYPE(obj, widtype);
1066 Widget_Data *wd = elm_widget_data_get(obj);
1067 if (!wd || !wd->entry) return;
1069 elm_entry_autocapitalization_set(wd->entry, autocap);
1073 * Set whether scrolled entry should support auto period
1075 * @param obj The entry object
1076 * @param on If true, scrolled entry suports auto period.
1078 * @ingroup Scrolled_Entry
1081 elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod)
1083 ELM_CHECK_WIDTYPE(obj, widtype);
1084 Widget_Data *wd = elm_widget_data_get(obj);
1085 if (!wd || !wd->entry) return;
1087 elm_entry_autoperiod_set(wd->entry, autoperiod);