gui_widget_list.h

/*
 * Copyright (c) 2019 Tilen MAJERLE
 *  
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without restriction,
 * including without limitation the rights to use, copy, modify, merge,
 * publish, distribute, sublicense, and/or sell copies of the Software, 
 * and to permit persons to whom the Software is furnished to do so, 
 * subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
 * AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * This file is part of EasyGUI library.
 *
 * Author:          Tilen Majerle <tilen@majerle.eu>
 */
#ifndef GUI_HDR_WIDGET_LIST_H
#define GUI_HDR_WIDGET_LIST_H

/* C++ detection */
#ifdef __cplusplus
extern "C" {
#endif

#include "gui_widget.h"

typedef struct {
    gui_linkedlistroot_t root;                      
    int16_t max_visible_items;                      
    int16_t count;                                  
    int16_t visiblestartindex;                      
    uint8_t (*check_values_cb)(gui_handle_p h);     
    int16_t (*entries_per_page_cb)(gui_handle_p h); 
    uint8_t (*remove_item_cb)(gui_handle_p h, void* item);  /* Remove item callback */
} gui_widget_listdata_t;

uint8_t     gui_widget_list_init(gui_handle_p h, gui_widget_listdata_t* const ld);
uint8_t     gui_widget_list_slide(gui_handle_p h, gui_widget_listdata_t* const ld, int16_t dir);
uint8_t     gui_widget_list_add_item(gui_handle_p h, gui_widget_listdata_t* const ld, void* element);
void *      gui_widget_list_get_item_byindex(gui_handle_p h, gui_widget_listdata_t* const ld, int16_t index);
uint8_t     gui_widget_list_remove_item_byindex(gui_handle_p h, gui_widget_listdata_t* const ld, int16_t index);
uint8_t     gui_widget_list_remove_items(gui_handle_p h, gui_widget_listdata_t* const ld);
uint8_t     gui_widget_list_check_values(gui_handle_p h, gui_widget_listdata_t* const ld);

uint8_t     gui_widget_list_inc_selection(gui_handle_p h, gui_widget_listdata_t* const ld, int16_t* const curr_selected, int16_t dir);
uint8_t     gui_widget_list_set_selection(gui_handle_p h, gui_widget_listdata_t* const ld, int16_t* const curr_selected, int16_t new_selection);

#define     gui_widget_list_get_count_pp(h, ld)             GUI_I16(((ld)->entries_per_page_cb != NULL) ? (ld)->entries_per_page_cb(h) : 0)

#define     gui_widget_list_get_visible_start_index(h, ld)  GUI_I16((ld)->visiblestartindex)
uint8_t     gui_widget_list_set_visible_start_index(gui_handle_p h, gui_widget_listdata_t* const ld, int16_t start);

#define     gui_widget_list_get_count(h, ld)                GUI_I16((ld)->count)

void *      gui_widget_list_get_first_visible_item(gui_handle_p h, gui_widget_listdata_t* const ld, int16_t* const index_out);
void *      gui_widget_list_get_next_item(gui_handle_p h, gui_widget_listdata_t* const ld, void* const curr_item);

/* C++ detection */
#ifdef __cplusplus
}
#endif

#endif /* GUI_HDR_WIDGET_LIST_H */