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:40:22 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2017-08-31 11:22:04 +0900
commitb6bab481aa8c4297f7692422b61dacf08f9e1d10 (patch)
tree82dceab2ef8b35e57eb10cb04a1f43345d1ed876 /src/lib/elementary/elm_widget.eo
parentb0fc5dde62f6392ccf2a46c5be6265e72260b137 (diff)
widget: Mark old focus API as beta.
It's not beta. It's about to die. Also, move #define ELM_WIDGET_BETA to the common header file, as it is consequently required by ALL widgets. :( Ping @bu5hm4n :) Ref T5363
Diffstat (limited to 'src/lib/elementary/elm_widget.eo')
-rw-r--r--src/lib/elementary/elm_widget.eo61
1 files changed, 31 insertions, 30 deletions
diff --git a/src/lib/elementary/elm_widget.eo b/src/lib/elementary/elm_widget.eo
index 7beafe85c2..c414a078c1 100644
--- a/src/lib/elementary/elm_widget.eo
+++ b/src/lib/elementary/elm_widget.eo
@@ -406,6 +406,11 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible,
406 } 406 }
407 return: bool; [[$true if this widget can handle focus, $false otherwise]] 407 return: bool; [[$true if this widget can handle focus, $false otherwise]]
408 } 408 }
409 /* FIXME: Needs better doc... maybe merge with widget_event? */
410 focus_mouse_up_handle {
411 [[Handle focus mouse up]]
412 legacy: null;
413 }
409 414
410 /* Scroll API. */ 415 /* Scroll API. */
411 @property on_show_region_hook @protected { 416 @property on_show_region_hook @protected {
@@ -525,13 +530,13 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible,
525 } 530 }
526 531
527 /* Old focus API. FIXME: Needs massive clean up! */ 532 /* Old focus API. FIXME: Needs massive clean up! */
528 @property focus_order { 533 @property focus_order @beta {
529 [[Focus order property]] 534 [[Focus order property]]
530 get { 535 get {
531 return: uint; [[FIXME]] 536 return: uint; [[FIXME]]
532 } 537 }
533 } 538 }
534 focus_next_object_set { 539 focus_next_object_set @beta {
535 [[Set the next object with specific focus direction. 540 [[Set the next object with specific focus direction.
536 541
537 @since 1.8]] 542 @since 1.8]]
@@ -540,7 +545,7 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible,
540 @in dir: Elm.Focus_Direction; [[Focus direction]] 545 @in dir: Elm.Focus_Direction; [[Focus direction]]
541 } 546 }
542 } 547 }
543 focus_next_object_get @const { 548 focus_next_object_get @const @beta {
544 [[Get the next object with specific focus direction. 549 [[Get the next object with specific focus direction.
545 550
546 @since 1.8]] 551 @since 1.8]]
@@ -549,7 +554,7 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible,
549 @in dir: Elm.Focus_Direction; [[Focus direction]] 554 @in dir: Elm.Focus_Direction; [[Focus direction]]
550 } 555 }
551 } 556 }
552 focus_next_item_set { 557 focus_next_item_set @beta {
553 [[Set the next object item with specific focus direction. 558 [[Set the next object item with specific focus direction.
554 559
555 @since 1.16]] 560 @since 1.16]]
@@ -558,7 +563,7 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible,
558 @in dir: Elm.Focus_Direction; [[Focus direction]] 563 @in dir: Elm.Focus_Direction; [[Focus direction]]
559 } 564 }
560 } 565 }
561 focus_next_item_get @const { 566 focus_next_item_get @const @beta {
562 [[Get the next object item with specific focus direction. 567 [[Get the next object item with specific focus direction.
563 568
564 @since 1.16]] 569 @since 1.16]]
@@ -567,7 +572,7 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible,
567 @in dir: Elm.Focus_Direction; [[Focus direction]] 572 @in dir: Elm.Focus_Direction; [[Focus direction]]
568 } 573 }
569 } 574 }
570 focus_custom_chain_prepend { 575 focus_custom_chain_prepend @beta {
571 [[Prepend object to custom focus chain. 576 [[Prepend object to custom focus chain.
572 577
573 Note: If @"relative_child" equal to $null or not in custom chain, 578 Note: If @"relative_child" equal to $null or not in custom chain,
@@ -579,14 +584,14 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible,
579 @in relative_child: Efl.Canvas.Object @optional; [[The relative object to position the child.]] 584 @in relative_child: Efl.Canvas.Object @optional; [[The relative object to position the child.]]
580 } 585 }
581 } 586 }
582 focus_cycle { 587 focus_cycle @beta {
583 [[Give focus to next object with specific focus direction in 588 [[Give focus to next object with specific focus direction in
584 object tree.]] 589 object tree.]]
585 params { 590 params {
586 @in dir: Elm.Focus_Direction; [[Direction to move the focus.]] 591 @in dir: Elm.Focus_Direction; [[Direction to move the focus.]]
587 } 592 }
588 } 593 }
589 focus_direction @pure_virtual { 594 focus_direction @pure_virtual @beta {
590 [['Virtual' function handling passing focus to sub-objects given a direction, in degrees.]] 595 [['Virtual' function handling passing focus to sub-objects given a direction, in degrees.]]
591 params { 596 params {
592 @in base: const(Efl.Canvas.Object); [[Base object]] 597 @in base: const(Efl.Canvas.Object); [[Base object]]
@@ -597,21 +602,21 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible,
597 } 602 }
598 return: bool; [[$true on success, $false otherwise]] 603 return: bool; [[$true on success, $false otherwise]]
599 } 604 }
600 focus_next_manager_is { 605 focus_next_manager_is @beta {
601 [['Virtual' function which checks if handling of passing focus to sub-objects is supported by widget.]] 606 [['Virtual' function which checks if handling of passing focus to sub-objects is supported by widget.]]
602 return: bool; [[$true on success, $false otherwise]] 607 return: bool; [[$true on success, $false otherwise]]
603 } 608 }
604 focused_object_clear { 609 focused_object_clear @beta {
605 [[Clear focused object]] 610 [[Clear focused object]]
606 } 611 }
607 focus_direction_go { 612 focus_direction_go @beta {
608 [[Go in focus direction]] 613 [[Go in focus direction]]
609 return: bool; [[$true on success, $false otherwise]] 614 return: bool; [[$true on success, $false otherwise]]
610 params { 615 params {
611 @in degree: double; [[Degree]] 616 @in degree: double; [[Degree]]
612 } 617 }
613 } 618 }
614 focus_next_get @const { 619 focus_next_get @const @beta {
615 [[Get next focus item]] 620 [[Get next focus item]]
616 return: bool; [[$true on success, $false otherwise]] 621 return: bool; [[$true on success, $false otherwise]]
617 params { 622 params {
@@ -620,28 +625,28 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible,
620 @out next_item: Elm.Widget.Item; [[Next item]] 625 @out next_item: Elm.Widget.Item; [[Next item]]
621 } 626 }
622 } 627 }
623 focus_restore { 628 focus_restore @beta {
624 [[Restore the focus state of the sub-tree. 629 [[Restore the focus state of the sub-tree.
625 630
626 This API will restore the focus state of the sub-tree to the latest 631 This API will restore the focus state of the sub-tree to the latest
627 state. If a sub-tree is unfocused and wants to get back to the latest 632 state. If a sub-tree is unfocused and wants to get back to the latest
628 focus state, this API will be helpful.]] 633 focus state, this API will be helpful.]]
629 } 634 }
630 focus_custom_chain_unset { 635 focus_custom_chain_unset @beta {
631 [[Unset a custom focus chain on a given Elementary widget. 636 [[Unset a custom focus chain on a given Elementary widget.
632 637
633 Any focus chain previously set is removed entirely after this call.]] 638 Any focus chain previously set is removed entirely after this call.]]
634 } 639 }
635 focus_steal { 640 focus_steal @beta {
636 [[Steal focus]] 641 [[Steal focus]]
637 params { 642 params {
638 @in item: Elm.Widget.Item @nullable; [[Widget to steal focus from]] 643 @in item: Elm.Widget.Item @nullable; [[Widget to steal focus from]]
639 } 644 }
640 } 645 }
641 focus_hide_handle { 646 focus_hide_handle @beta {
642 [[Handle hide focus]] 647 [[Handle hide focus]]
643 } 648 }
644 focus_next @pure_virtual { 649 focus_next @pure_virtual @beta {
645 [['Virtual' function handling passing focus to sub-objects.]] 650 [['Virtual' function handling passing focus to sub-objects.]]
646 params { 651 params {
647 @in dir: Elm.Focus_Direction; [[Focus direction]] 652 @in dir: Elm.Focus_Direction; [[Focus direction]]
@@ -650,11 +655,7 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible,
650 } 655 }
651 return: bool; [[$true on success, $false otherwise]] 656 return: bool; [[$true on success, $false otherwise]]
652 } 657 }
653 focus_mouse_up_handle { 658 focus_direction_get @const @beta {
654 [[Handle focus mouse up]]
655 legacy: null;
656 }
657 focus_direction_get @const {
658 [[Get focus direction]] 659 [[Get focus direction]]
659 return: bool; [[$true on success, $false otherwise]] 660 return: bool; [[$true on success, $false otherwise]]
660 params { 661 params {
@@ -665,10 +666,10 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible,
665 @out weight: double; [[Weight]] 666 @out weight: double; [[Weight]]
666 } 667 }
667 } 668 }
668 focus_disabled_handle { 669 focus_disabled_handle @beta {
669 [[Handle disable widget focus]] 670 [[Handle disable widget focus]]
670 } 671 }
671 focus_custom_chain_append { 672 focus_custom_chain_append @beta {
672 [[Append object to custom focus chain. 673 [[Append object to custom focus chain.
673 674
674 Note: If @"relative_child" equal to $null or not in custom chain, 675 Note: If @"relative_child" equal to $null or not in custom chain,
@@ -680,13 +681,13 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible,
680 @in relative_child: Efl.Canvas.Object @optional; [[The relative object to position the child.]] 681 @in relative_child: Efl.Canvas.Object @optional; [[The relative object to position the child.]]
681 } 682 }
682 } 683 }
683 @property focus_move_policy { 684 @property focus_move_policy @beta {
684 [[The widget's focus move policy.]] 685 [[The widget's focus move policy.]]
685 values { 686 values {
686 policy: Efl.Ui.Focus.Move_Policy; [[Focus move policy]] 687 policy: Efl.Ui.Focus.Move_Policy; [[Focus move policy]]
687 } 688 }
688 } 689 }
689 @property focus_move_policy_automatic { 690 @property focus_move_policy_automatic @beta {
690 [[Control the widget's focus_move_policy mode setting. 691 [[Control the widget's focus_move_policy mode setting.
691 692
692 @since 1.18]] 693 @since 1.18]]
@@ -694,10 +695,10 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible,
694 automatic: bool; [[$true to follow system focus move policy change, $false otherwise]] 695 automatic: bool; [[$true to follow system focus move policy change, $false otherwise]]
695 } 696 }
696 } 697 }
697 focus_reconfigure { 698 focus_reconfigure @beta {
698 [[@since 1.18]] 699 [[@since 1.18]]
699 } 700 }
700 @property focus_custom_chain { 701 @property focus_custom_chain @beta {
701 [[A custom chain of objects to pass focus. 702 [[A custom chain of objects to pass focus.
702 703
703 Note: On focus cycle, only will be evaluated children of this container.]] 704 Note: On focus cycle, only will be evaluated children of this container.]]
@@ -715,13 +716,13 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible,
715 } 716 }
716 } 717 }
717 } 718 }
718 @property focused_item { 719 @property focused_item @beta {
719 get { 720 get {
720 [[Get the focused widget item.]] 721 [[Get the focused widget item.]]
721 return: Elm.Widget.Item; [[Focused item]] 722 return: Elm.Widget.Item; [[Focused item]]
722 } 723 }
723 } 724 }
724 @property focused_object { 725 @property focused_object @beta {
725 [[Current focused object in object tree.]] 726 [[Current focused object in object tree.]]
726 get { 727 get {
727 return: Efl.Canvas.Object; [[Current focused or $null, if there is no focused object.]] 728 return: Efl.Canvas.Object; [[Current focused or $null, if there is no focused object.]]