path: root/src/calcurse.h
diff options
authorLars Henriksen <LarsHenriksen@get2net.dk>2018-12-19 08:59:05 +0100
committerLukas Fleischer <lfleischer@calcurse.org>2019-05-22 01:56:59 -0400
commit1ccfe128cce8d670d12c350326bb13fbc0276d0a (patch)
tree116fd3e8861e13cc22060ce2eb47593381a8f61c /src/calcurse.h
parent066df02cbf44d58a9b1e3a30b1310dc0f460e4c4 (diff)
Redesign selected-item implementation for the APP panel
The day vector, day_items, is displayed in the appointments panel; the selected day_item object is highlighted (when the panel has the focus). When items are inserted, edited, moved etc., and when the day is changed, the day vector is rebuilt and displayed anew. Problem: How shall the selection be set automatically in the context of the new day vector? In previous versions all of the above is mostly handled by the function do_storage() in calcurse.c The function saves data about the selection as needed, rebuilds the day vector, loads the listbox and sets the selection from the saved selection data. This works well in "single day" calcurse in cases where the selected item is present in the day vector both before and after the rebuild, or when the item ordering in the listbox is unaffected by the changes. But when a new item is added the selection cannot be set to the new object by do_storage(). Instead the necessary operations are performed by ui_day_item_add(), and do_storage() is bypassed. In general, when an item cannot be found in the new vector, the item which occupies the old place in the list gets selected, e.g. when an item is deleted. When an item is turned into a repeating one, the old item is deleted and a new is created. Here the new selection is not always the affected item, but in any case not far away. Generally, with only one day in the panel an erronous selection might not be noticed or be accurate by chance. In "multiple day" calcurse the existing scheme works less well; in addition the day vector may now contain more than one object that refer to the same event or appointment (recurrent items or multi-day appointments). The scheme has therefore been modified. The do_storage() function is no longer bypassed, but handles day vector rebuild, load of listbox and item selection exclusively. To make that possible, data about the selected item is no longer saved in a local automatic variable, private to do_storage(), but in an external static variable in day.c, which may be set not only by do_storage(). The variable is declared as static struct day_item sel_data; and used as follows: 1. On startup sel_data is initialized to empty (i.e. no selection). 2. In any operation involving the appointments panel: 2.1 Do the work and if necessary set sel_data. This is the case when deleting, adding or pasting an item, and when turning an ordinary item into a recurrent one. 2.2 Call do_storage(). 3. In do_storage(): 3.1 If sel_data is empty, set it to the current selection. 3.2 Rebuild the day vector. 3.3 Set the selection from sel_data. 3.4 Set sel_data to empty. Further remarks --------------- The selection is found in the new day vector by searching for the saved (order, item.<pointer>) pair. Previously the item.<pointer> alone sufficed and in some cases it still does. In case the item cannot be found, the selection stays in the same day as before the rebuild. An attempt at more consistently named APP-related functions has led to: ui_day_sel_date() replaces ui_day_sel_day() ui_day_get_sel() replaces ui_day_selitem() Signed-off-by: Lars Henriksen <LarsHenriksen@get2net.dk> Signed-off-by: Lukas Fleischer <lfleischer@calcurse.org>
Diffstat (limited to 'src/calcurse.h')
1 files changed, 10 insertions, 6 deletions
diff --git a/src/calcurse.h b/src/calcurse.h
index 3ee0900..333e1b9 100644
--- a/src/calcurse.h
+++ b/src/calcurse.h
@@ -762,6 +762,9 @@ void apoint_paste_item(struct apoint *, time_t);
int parse_args(int, char **);
/* calendar.c */
+extern struct day_item empty_day;
+/* ui_calendar.c */
void ui_calendar_view_next(void);
void ui_calendar_view_prev(void);
void ui_calendar_set_view(int);
@@ -801,6 +804,9 @@ void custom_config_main(void);
/* day.c */
int day_get_nb(void);
+int day_set_sel_data(struct day_item *);
+int day_check_sel_data(void);
+int day_sel_index(void);
void day_free_vector(void);
char *day_item_get_mesg(struct day_item *);
char *day_item_get_note(struct day_item *);
@@ -819,8 +825,6 @@ int day_check_if_item(struct date);
unsigned day_chk_busy_slices(struct date, int, int *);
struct day_item *day_cut_item(time_t, int);
int day_paste_item(struct day_item *, time_t);
-int day_get_position_by_aptev_ptr(union aptev_ptr);
-int day_get_position(struct day_item *);
struct day_item *day_get_item(int);
unsigned day_item_count(int);
void day_edit_note(struct day_item *, const char *);
@@ -1097,10 +1101,6 @@ void todo_init_list(void);
void todo_free_list(void);
/* ui-day.c */
-struct day_item *ui_day_selitem(void);
-time_t ui_day_selday(void);
-void ui_day_set_selitem_by_aptev_ptr(union aptev_ptr);
-void ui_day_set_selitem(struct day_item *);
void ui_day_item_add(void);
void ui_day_item_delete(unsigned);
void ui_day_item_edit(void);
@@ -1110,7 +1110,11 @@ void ui_day_item_cut_free(unsigned);
void ui_day_item_copy(unsigned);
void ui_day_item_paste(unsigned);
void ui_day_load_items(void);
+void ui_day_find_sel(void);
+struct day_item *ui_day_get_sel(void);
+time_t ui_day_sel_date(void);
void ui_day_sel_reset(void);
+void ui_day_set_sel(struct day_item *);
void ui_day_sel_move(int);
void ui_day_draw(int, WINDOW *, int, int, void *);
enum listbox_row_type ui_day_row_type(int, void *);