fw/applib/ui/menu_layer: add scroll wrap around capability

Signed-off-by: Paul Chanvin <[email protected]>

Author: MrXANA91

src/fw/applib/ui/menu_layer.c

@@ -76,14 +76,57 @@ static void prv_menu_select_long_click_handler(ClickRecognizerRef recognizer,
   }
 }
 
+static inline uint16_t prv_menu_layer_get_num_sections(MenuLayer *menu_layer);
+static inline uint16_t prv_menu_layer_get_num_rows(MenuLayer *menu_layer, uint16_t section_index);
+
+//! Handle the menu scroll wrap around
+//! @param menu_layer reference to the current MenuLayer
+//! @param recognizer reference to the ClickRecognizer struct
+//! @param scrolling_up `true` if scrolling up, `false` if scrolling down
+//! @return `true` if a wrap around has been applied
+static bool prv_menu_scroll_handle_wrap_around(MenuLayer *menu_layer, ClickRecognizerRef recognizer, bool scrolling_up) {
+  const uint8_t current_scroll_action = scrolling_up ? MenuLayerRepeatScrollingUp : MenuLayerRepeatScrollingDown;
+  const bool is_repeating = click_recognizer_is_repeating(recognizer);
+
+  if (is_repeating) {
+    menu_layer->cache.button_repeat_scrolling = current_scroll_action;
+    return false;
+  }
+  menu_layer->cache.button_repeat_scrolling = MenuLayerNoRepeatScrolling;
+
+  MenuIndex current_index = menu_layer->selection.index;
+  int last_index_section = prv_menu_layer_get_num_sections(menu_layer) - 1;
+  int last_index_row = prv_menu_layer_get_num_rows(menu_layer, last_index_section) - 1;
+  MenuIndex first_index = MenuIndex(0, 0);
+  MenuIndex last_index = MenuIndex(last_index_section, last_index_row);
+  MenuIndex *wraparound_dest_index;
+  if ((menu_index_compare(&current_index, &first_index) == 0) && scrolling_up) {
+    wraparound_dest_index = &last_index;
+  } else if ((menu_index_compare(&current_index, &last_index) == 0) && !scrolling_up) {
+    wraparound_dest_index = &first_index;
+  } else {
+    return false;
+  }
+
+  const bool animated = true;
+  menu_layer_set_selected_index(menu_layer, *wraparound_dest_index, MenuRowAlignCenter, animated);
+  return true;
+}
+
 void menu_up_click_handler(ClickRecognizerRef recognizer, MenuLayer *menu_layer) {
   const bool up = true;
+  if (menu_layer->scroll_wrap_around && prv_menu_scroll_handle_wrap_around(menu_layer, recognizer, up)) {
+    return;
+  }
   const bool animated = true;
   menu_layer_set_selected_next(menu_layer, up, MenuRowAlignCenter, animated);
 }
 
 void menu_down_click_handler(ClickRecognizerRef recognizer, MenuLayer *menu_layer) {
   const bool up = false;
+  if (menu_layer->scroll_wrap_around && prv_menu_scroll_handle_wrap_around(menu_layer, recognizer, up)) {
+    return;
+  }
   const bool animated = true;
   menu_layer_set_selected_next(menu_layer, up, MenuRowAlignCenter, animated);
 }
@@ -1293,3 +1336,14 @@ void menu_layer_set_center_focused(MenuLayer *menu_layer, bool center_focused) {
   prv_set_center_focused(menu_layer, center_focused);
   menu_layer_update_caches(menu_layer);
 }
+
+bool menu_layer_get_scroll_wrap_around(MenuLayer *menu_layer) {
+  return menu_layer->scroll_wrap_around;
+}
+
+void menu_layer_set_scroll_wrap_around(MenuLayer *menu_layer, bool scroll_wrap_around) {
+  if (!menu_layer) {
+    return;
+  }
+  menu_layer->scroll_wrap_around = scroll_wrap_around;
+}

src/fw/applib/ui/menu_layer.h

@@ -338,6 +338,12 @@ enum {
 _Static_assert(MenuLayerColor_Count == 2, "Bad enum MenuLayerColor");
 #endif
 
+enum {
+  MenuLayerNoRepeatScrolling = 0,
+  MenuLayerRepeatScrollingUp = 1,
+  MenuLayerRepeatScrollingDown = 2,
+};
+
 //! Data structure of a MenuLayer.
 //! @note a `MenuLayer *` can safely be casted to a `Layer *` and
 //! `ScrollLayer *` and can thus be used with all other functions that take a
@@ -359,6 +365,8 @@ typedef struct MenuLayer {
     //! @internal
     //! Cell index + geometry cache of a cell that was in frame during the last redraw
     MenuCellSpan cursor;
+
+    uint8_t button_repeat_scrolling:2;
   } cache;
   //! @internal
   //! Selected cell index + geometery cache of the selected cell
@@ -401,10 +409,14 @@ typedef struct MenuLayer {
   //! independent of the scrolling animation.
   bool selection_animation_disabled:1;
 
+  //! If true, the MenuLayer will be able to wrap around the first element and the last element
+  //! when scrolling.
+  bool scroll_wrap_around:1;
+
   //! Add some padding to keep track of the \ref MenuLayer size budget.
   //! As long as the size stays within this budget, 2.x apps can safely use the 3.x MenuLayer type.
   //! When padding is removed, the assertion below should also be removed.
-  uint8_t padding[44];
+  uint8_t padding[40];
 } MenuLayer;
 
 //! Padding used below the last item in pixels
@@ -612,6 +624,19 @@ bool menu_layer_get_center_focused(MenuLayer *menu_layer);
 //! @see \ref menu_layer_get_center_focused
 void menu_layer_set_center_focused(MenuLayer *menu_layer, bool center_focused);
 
+//! True, if the \ref MenuLayer can wrap around the first and last element.
+//! @see \ref menu_layer_set_scroll_wrap_around
+bool menu_layer_get_scroll_wrap_around(MenuLayer *menu_layer);
+
+//! Controls if the \ref MenuLayer can wrap around from the first element to the last when going 
+//! up and from the last element to the first when going down.
+//! Even enabled, wrap around will stay disabled when holding down the navigation buttons (up or down).
+//! Defaults to false for every platform
+//! @param menu_layer The menu layer for which to enable or disable the behavior.
+//! @param scroll_wrap_around true = enable the wrap around, false = disable it.
+//! @see \ref menu_layer_get_scroll_wrap_around
+void menu_layer_set_scroll_wrap_around(MenuLayer *menu_layer, bool scroll_wrap_around);
+
 
 //!     @} // end addtogroup MenuLayer
 //!   @} // end addtogroup Layer

src/fw/apps/system_apps/alarms/alarm_editor.c

@@ -259,6 +259,7 @@ static void prv_setup_day_picker_window(AlarmEditorData *data) {
                                   ALARMS_APP_HIGHLIGHT_COLOR,
                                   GColorWhite);
   menu_layer_set_click_config_onto_window(&data->day_picker_menu_layer, &data->day_picker_window);
+  menu_layer_set_scroll_wrap_around(&data->day_picker_menu_layer, true);
   layer_add_child(&data->day_picker_window.layer,
                   menu_layer_get_layer(&data->day_picker_menu_layer));
   if (!alarm_get_kind(data->alarm_id, &data->alarm_kind)) {
@@ -414,6 +415,7 @@ static void prv_setup_custom_day_picker_window(AlarmEditorData *data) {
                                   GColorWhite);
   menu_layer_set_click_config_onto_window(&data->custom_day_picker_menu_layer,
                                           &data->custom_day_picker_window);
+  menu_layer_set_scroll_wrap_around(&data->custom_day_picker_menu_layer, true);
   layer_add_child(&data->custom_day_picker_window.layer,
                   menu_layer_get_layer(&data->custom_day_picker_menu_layer));
   gbitmap_init_with_resource(&data->selected_icon, RESOURCE_ID_CHECKBOX_ICON_CHECKED);

src/fw/apps/system_apps/alarms/alarms.c

@@ -402,6 +402,7 @@ static void prv_handle_init(void) {
 
   menu_layer_set_highlight_colors(&data->menu_layer, ALARMS_APP_HIGHLIGHT_COLOR, GColorWhite);
   menu_layer_set_click_config_onto_window(&data->menu_layer, &data->window);
+  menu_layer_set_scroll_wrap_around(&data->menu_layer, true);
   layer_add_child(&data->window.layer, menu_layer_get_layer(&data->menu_layer));
 
   status_bar_layer_init(&data->status_layer);

src/fw/apps/system_apps/health/health_detail_card.c

@@ -391,6 +391,7 @@ HealthDetailCard *health_detail_card_create(const HealthDetailCardConfig *config
   menu_layer_set_normal_colors(menu_layer, detail_card->bg_color, GColorWhite);
   menu_layer_set_highlight_colors(menu_layer, detail_card->bg_color, GColorBlack);
   menu_layer_set_click_config_onto_window(menu_layer, &detail_card->window);
+  menu_layer_set_scroll_wrap_around(menu_layer, true);
   layer_add_child(&detail_card->window.layer, menu_layer_get_layer(menu_layer));
 
   // setup content indicators

src/fw/apps/system_apps/launcher/default/launcher_menu_layer.c

@@ -202,6 +202,7 @@ void launcher_menu_layer_init(LauncherMenuLayer *launcher_menu_layer,
     .get_cell_height = prv_menu_layer_get_cell_height,
     .selection_will_change = prv_menu_layer_selection_will_change,
   });
+  menu_layer_set_scroll_wrap_around(menu_layer, true);
 
   // Only setup the content indicator on round
 #if PBL_ROUND

src/fw/apps/system_apps/notifications_app.c

@@ -701,6 +701,7 @@ static void prv_window_load(Window *window) {
                                   GColorWhite);
 
   menu_layer_set_click_config_onto_window(menu_layer, window);
+  menu_layer_set_scroll_wrap_around(menu_layer, true);
   layer_add_child(&window->layer, menu_layer_get_layer(menu_layer));
 
   TextLayer *text_layer = &data->text_layer;

src/fw/apps/system_apps/send_text/send_text.c

@@ -325,6 +325,7 @@ static void prv_init(void) {
 
     menu_layer_set_highlight_colors(&data->menu_layer, SEND_TEXT_APP_HIGHLIGHT_COLOR, GColorWhite);
     menu_layer_set_click_config_onto_window(&data->menu_layer, &data->window);
+    menu_layer_set_scroll_wrap_around(&data->menu_layer, true);
     layer_add_child(&data->window.layer, menu_layer_get_layer(&data->menu_layer));
 
     StatusBarLayer *status_layer = &data->status_layer;

src/fw/apps/system_apps/settings/settings.c

@@ -92,6 +92,7 @@ static void prv_window_load(Window *window) {
                                   shell_prefs_get_settings_menu_highlight_color(),
                                   GColorWhite);
   menu_layer_set_click_config_onto_window(menu_layer, &data->window);
+  menu_layer_set_scroll_wrap_around(menu_layer, true);
 
   layer_add_child(&data->window.layer, menu_layer_get_layer(menu_layer));
 }

src/fw/apps/system_apps/settings/settings_system.c

@@ -305,6 +305,7 @@ static void prv_information_window_load(Window *window) {
   });
   menu_layer_set_highlight_colors(menu_layer, shell_prefs_get_settings_menu_highlight_color(), GColorWhite);
   menu_layer_set_click_config_onto_window(menu_layer, &data->window);
+  menu_layer_set_scroll_wrap_around(menu_layer, true);
 
   layer_add_child(&data->window.layer, menu_layer_get_layer(menu_layer));
 }
@@ -723,6 +724,7 @@ static void prv_debugging_window_load(Window *window) {
   });
   menu_layer_set_highlight_colors(menu_layer, shell_prefs_get_settings_menu_highlight_color(), GColorWhite);
   menu_layer_set_click_config_onto_window(menu_layer, &data->window);
+  menu_layer_set_scroll_wrap_around(menu_layer, true);
 
   layer_add_child(&data->window.layer, menu_layer_get_layer(menu_layer));
 }
@@ -1169,6 +1171,7 @@ static void prv_certification_window_load(Window *window) {
   });
   menu_layer_set_highlight_colors(menu_layer, shell_prefs_get_settings_menu_highlight_color(), GColorWhite);
   menu_layer_set_click_config_onto_window(menu_layer, &data->window);
+  menu_layer_set_scroll_wrap_around(menu_layer, true);
 
   layer_add_child(&data->window.layer, menu_layer_get_layer(menu_layer));
 }