summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_widget.eo
diff options
context:
space:
mode:
authorJean-Philippe Andre <jp.andre@samsung.com>2017-08-30 16:22:32 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2017-08-30 17:29:52 +0900
commitc9fcdbc68cddaceb089fd0c6016f73ce7302be9f (patch)
tree6b4eea1073ca632bb383edea3f9f505257c2b89f /src/lib/elementary/elm_widget.eo
parent692282e67a2888446743275ce3c8c973d5912b6c (diff)
widget: Mark some functions as protected
I believe all of those APIs are in fact meant for widgets to use themselves: - on_focus - on_show_region_hook - focus_region - focus_register - focus_manager_factory Ref T5363
Diffstat (limited to 'src/lib/elementary/elm_widget.eo')
-rw-r--r--src/lib/elementary/elm_widget.eo38
1 files changed, 21 insertions, 17 deletions
diff --git a/src/lib/elementary/elm_widget.eo b/src/lib/elementary/elm_widget.eo
index f083620154..f5a5e6edfa 100644
--- a/src/lib/elementary/elm_widget.eo
+++ b/src/lib/elementary/elm_widget.eo
@@ -404,16 +404,17 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible,
404 return: Efl.Ui.Theme.Apply; [[Indicates success, and if the current 404 return: Efl.Ui.Theme.Apply; [[Indicates success, and if the current
405 theme or default theme was used.]] 405 theme or default theme was used.]]
406 } 406 }
407 on_focus { 407 on_focus @protected {
408 [['Virtual' function handling focus in/out events on the widget]] 408 [[Virtual function handling focus in/out events on the widget]]
409 params { 409 params {
410 /* FIXME: EO API is not supposed to have any widget item!!! */
410 @in item: Elm.Widget.Item @nullable; [[Widget]] 411 @in item: Elm.Widget.Item @nullable; [[Widget]]
411 } 412 }
412 return: bool; [[$true if this widget can handle focus, $false otherwise]] 413 return: bool; [[$true if this widget can handle focus, $false otherwise]]
413 } 414 }
414 415
415 /* Scroll API. */ 416 /* Scroll API. */
416 @property on_show_region_hook { 417 @property on_show_region_hook @protected {
417 [[Hook function called when the @.show_region is changed. 418 [[Hook function called when the @.show_region is changed.
418 419
419 See also @.show_region. 420 See also @.show_region.
@@ -466,7 +467,7 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible,
466 467
467 /* FIXME: This is not 100% related to focus. This documentation needs 468 /* FIXME: This is not 100% related to focus. This documentation needs
468 * further fixing. */ 469 * further fixing. */
469 @property focus_region { 470 @property focus_region @protected {
470 [[Region to show when focus changes within this widget. 471 [[Region to show when focus changes within this widget.
471 472
472 When this widget or one of its subwidgets is given focus, this 473 When this widget or one of its subwidgets is given focus, this
@@ -497,10 +498,10 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible,
497 See also @.focus_region. 498 See also @.focus_region.
498 ]] 499 ]]
499 } 500 }
500 /* FIXME: This enum is in Elm namespace! */
501 @property focus_region_show_mode { 501 @property focus_region_show_mode {
502 [[Control the focus_region_show mode.]] 502 [[Control the focus_region_show mode.]]
503 values { 503 values {
504 /* FIXME: This enum is in Elm namespace! */
504 mode: Elm.Focus.Region.Show_Mode; [[Focus region show mode]] 505 mode: Elm.Focus.Region.Show_Mode; [[Focus region show mode]]
505 } 506 }
506 } 507 }
@@ -734,27 +735,30 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible,
734 } 735 }
735 736
736 /* Focus Manager API */ 737 /* Focus Manager API */
737 focus_register { 738 focus_register @protected {
738 [[Register focus with focus manager]] 739 [[Register focus with the given focus manager.]]
739 params { 740 params {
740 manager : Efl.Ui.Focus.Manager; [[The manager to register against]] 741 @in manager: Efl.Ui.Focus.Manager; [[The focus manager to register with.]]
741 logical : Efl.Ui.Focus.Object; [[The logical parent to use]] 742 @in logical: Efl.Ui.Focus.Object; [[The logical parent to use.]]
742 @inout logical_flag : bool; [[reference to the flag indicating if the should be logical or not change this flag to the value you have it registered]] 743 /* FIXME: The below doc needs fixing! */
744 @inout logical_flag: bool; [[reference to the flag indicating if the should be logical or not change this flag to the value you have it registered]]
743 } 745 }
744 return : bool; [[return $true or $false if the registration was successfull or not]] 746 return: bool; [[return $true or $false if the registration was successfull or not]]
745 } 747 }
746 focus_manager_factory { 748 focus_manager_factory @protected {
747 [[If the widget needs a manager, this function is called 749 [[If the widget needs a focus manager, this function will be called.
748 750
749 It can be used and overriden to inject your own manager or set custom options on the manager 751 It can be used and overriden to inject your own manager or set
752 custom options on the focus manager.
750 ]] 753 ]]
751 params { 754 params {
752 root : Efl.Ui.Focus.Object; [[the logical root to use in the manager.]] 755 @in root: Efl.Ui.Focus.Object; [[The logical root object for focus.]]
753 } 756 }
754 return : Efl.Ui.Focus.Manager; 757 return: Efl.Ui.Focus.Manager;
755 } 758 }
756 focus_direction_manager_is @protected { 759 focus_direction_manager_is @protected {
757 [['Virtual' function which checks if handling of passing focus to sub-objects in given direction is supported by widget.]] 760 [[Virtual function which checks if this widget can handle passing
761 focus to sub-object, in a given direction.]]
758 return: bool; [[$true on success, $false otherwise]] 762 return: bool; [[$true on success, $false otherwise]]
759 legacy: null; 763 legacy: null;
760 } 764 }