edje: add "mask_flags" instruction for "part" block

Summary:
Elementary widgets dealing with Evas Events usually mask event_flags with
EVAS_EVENT_FLAG_ON_HOLD, to show that this event is already handled.
However, widget like Elm_Button, it does not handle EVAS_CALLBACK_MOUSE_DOWN directly,
but it handles Edje_Signal instead, so there's no chance to mask event_flags.
Developers can block event propagation by putting rectangle the very last part of EDC,
but this instruction can help the case making elementary widget with only Edje_Signal handling.
This is not required essentially, so please check the necessity of this function.

Reviewers: Hermet, cedric

Reviewed By: cedric

Subscribers: cedric, Hermet

Differential Revision: https://phab.enlightenment.org/D2764

Signed-off-by: Cedric BAIL <cedric@osg.samsung.com>

4 files changed, 35 insertions, 0 deletions

diff --git a/src/bin/edje/edje_cc_handlers.c b/src/bin/edje/edje_cc_handlers.c
index f6458f867a..7834ffbbee 100644
--- a/src/bin/edje/edje_cc_handlers.c
+++ b/src/bin/edje/edje_cc_handlers.c
@@ -253,6 +253,7 @@ static void st_collections_group_parts_part_mouse_events(void);
 static void st_collections_group_parts_part_anti_alias(void);
 static void st_collections_group_parts_part_repeat_events(void);
 static void st_collections_group_parts_part_ignore_flags(void);
+static void st_collections_group_parts_part_mask_flags(void);
 static void st_collections_group_parts_part_scale(void);
 static void st_collections_group_parts_part_pointer_mode(void);
 static void st_collections_group_parts_part_precise_is_inside(void);
@@ -691,6 +692,7 @@ New_Statement_Handler statement_handlers[] =
      {"collections.group.parts.part.anti_alias", st_collections_group_parts_part_anti_alias},
      {"collections.group.parts.part.repeat_events", st_collections_group_parts_part_repeat_events},
      {"collections.group.parts.part.ignore_flags", st_collections_group_parts_part_ignore_flags},
+     {"collections.group.parts.part.mask_flags", st_collections_group_parts_part_mask_flags},
      {"collections.group.parts.part.scale", st_collections_group_parts_part_scale},
      {"collections.group.parts.part.pointer_mode", st_collections_group_parts_part_pointer_mode},
      {"collections.group.parts.part.precise_is_inside", st_collections_group_parts_part_precise_is_inside},
@@ -983,6 +985,7 @@ New_Statement_Handler statement_handlers[] =
              before -> insert_before
              after -> insert_after
              ignore -> ignore_flags
+             mask -> mask_flags
              pointer -> pointer_mode
              alt_font -> use_alternate_font_metrics
              clip -> clip_to
@@ -1006,6 +1009,7 @@ New_Statement_Handler statement_handlers_short[] =
      {"collections.group.parts.part.before", st_collections_group_parts_part_insert_before},
      {"collections.group.parts.part.after", st_collections_group_parts_part_insert_after},
      {"collections.group.parts.part.ignore", st_collections_group_parts_part_ignore_flags},
+     {"collections.group.parts.part.mask", st_collections_group_parts_part_mask_flags},
      {"collections.group.parts.part.pointer", st_collections_group_parts_part_pointer_mode},
      {"collections.group.parts.part.alt_font", st_collections_group_parts_part_use_alternate_font_metrics},
      {"collections.group.parts.part.clip", st_collections_group_parts_part_clip_to_id},
@@ -3433,6 +3437,7 @@ _part_copy(Edje_Part *ep, Edje_Part *ep2)
    ep->anti_alias = ep2->anti_alias;
    ep->repeat_events = ep2->repeat_events;
    ep->ignore_flags = ep2->ignore_flags;
+   ep->mask_flags = ep2->mask_flags;
    ep->scale = ep2->scale;
    ep->pointer_mode = ep2->pointer_mode;
    ep->precise_is_inside = ep2->precise_is_inside;
@@ -4422,6 +4427,7 @@ st_collections_group_parts_alias(void)
                     mouse_events:  1;
                     repeat_events: 0;
                     ignore_flags: NONE;
+                    mask_flags: NONE;
                     clip_to: "anotherpart";
                     source:  "groupname";
                     pointer_mode: AUTOGRAB;
@@ -4473,6 +4479,7 @@ edje_cc_handlers_part_make(int id)
    ep->anti_alias = 1;
    ep->repeat_events = 0;
    ep->ignore_flags = EVAS_EVENT_FLAG_NONE;
+   ep->mask_flags = EVAS_EVENT_FLAG_NONE;
    ep->scale = 0;
    ep->pointer_mode = EVAS_OBJECT_POINTER_MODE_AUTOGRAB;
    ep->precise_is_inside = 0;
@@ -5264,6 +5271,31 @@ st_collections_group_parts_part_ignore_flags(void)
 /**
     @page edcref
     @property
+        mask_flags
+    @parameters
+        [FLAG] ...
+    @effect
+        Masks event flags with the given value, so event propagating from this part
+        will go with masked flags. Other library, like Elementary, can determine
+        whether it handles this event. Possible flags:
+            @li NONE (default value, no event will be masked)
+            @li ON_HOLD
+    @endproperty
+*/
+static void
+st_collections_group_parts_part_mask_flags(void)
+{
+   check_min_arg_count(1);
+
+   current_part->mask_flags = parse_flags(0,
+                                  "NONE", EVAS_EVENT_FLAG_NONE,
+                                  "ON_HOLD", EVAS_EVENT_FLAG_ON_HOLD,
+                                  NULL);
+}
+
+/**
+    @page edcref
+    @property
         scale
     @parameters
         [1 or 0]
diff --git a/src/bin/edje/edje_convert.c b/src/bin/edje/edje_convert.c
index fc98722a7b..25afe10dfa 100644
--- a/src/bin/edje/edje_convert.c
+++ b/src/bin/edje/edje_convert.c
@@ -351,6 +351,7 @@ _edje_collection_convert(Eet_File *ef, Edje_Part_Collection_Directory_Entry *ce,
         replacement->mouse_events = part->mouse_events;
         replacement->repeat_events = part->repeat_events;
         replacement->ignore_flags = part->ignore_flags;
+        replacement->mask_flags = part->mask_flags;
         replacement->scale = part->scale;
         replacement->precise_is_inside = part->precise_is_inside;
         replacement->use_alternate_font_metrics = part->use_alternate_font_metrics;
diff --git a/src/bin/edje/edje_convert.h b/src/bin/edje/edje_convert.h
index 0bbb38eb42..fe2bff182d 100644
--- a/src/bin/edje/edje_convert.h
+++ b/src/bin/edje/edje_convert.h
@@ -102,6 +102,7 @@ struct _Old_Edje_Part
    unsigned char          mouse_events; /* it will affect/respond to mouse events */
    unsigned char          repeat_events; /* it will repeat events to objects below */
    Evas_Event_Flags       ignore_flags;
+   Evas_Event_Flags       mask_flags;
    unsigned char          scale; /* should certain properties scale with edje scale factor? */
    unsigned char          precise_is_inside;
    unsigned char          use_alternate_font_metrics;
diff --git a/src/bin/edje/edje_data_convert.c b/src/bin/edje/edje_data_convert.c
index ac7d52d5b3..bea6eeb7e5 100644
--- a/src/bin/edje/edje_data_convert.c
+++ b/src/bin/edje/edje_data_convert.c
@@ -399,6 +399,7 @@ _edje_edd_old_init(void)
    EET_DATA_DESCRIPTOR_ADD_BASIC(_edje_edd_old_edje_part, Old_Edje_Part, "anti_alias", anti_alias, EET_T_UCHAR);
    EET_DATA_DESCRIPTOR_ADD_BASIC(_edje_edd_old_edje_part, Old_Edje_Part, "repeat_events", repeat_events, EET_T_UCHAR);
    EET_DATA_DESCRIPTOR_ADD_BASIC(_edje_edd_old_edje_part, Old_Edje_Part, "ignore_flags", ignore_flags, EET_T_INT);
+   EET_DATA_DESCRIPTOR_ADD_BASIC(_edje_edd_old_edje_part, Old_Edje_Part, "mask_flags", mask_flags, EET_T_INT);
    EET_DATA_DESCRIPTOR_ADD_BASIC(_edje_edd_old_edje_part, Old_Edje_Part, "scale", scale, EET_T_UCHAR);
    EET_DATA_DESCRIPTOR_ADD_BASIC(_edje_edd_old_edje_part, Old_Edje_Part, "pointer_mode", pointer_mode, EET_T_UCHAR);
    EET_DATA_DESCRIPTOR_ADD_BASIC(_edje_edd_old_edje_part, Old_Edje_Part, "precise_is_inside", precise_is_inside, EET_T_UCHAR);