gp_widget_table.h

//SPDX-License-Identifier: LGPL-2.0-or-later
 
/*
 
   Copyright (c) 2014-2021 Cyril Hrubis <metan@ucw.cz>
 
 */
 
#ifndef GP_WIDGET_TABLE_H
#define GP_WIDGET_TABLE_H
 
enum gp_widget_table_row_op {
        GP_TABLE_ROW_RESET,
        GP_TABLE_ROW_ADVANCE,
        GP_TABLE_ROW_MAX
};
 
typedef struct gp_widget_table_cell {
        const char *text;
        gp_widget_tattr tattr;
} gp_widget_table_cell;
 
typedef struct gp_widget_table_col_dsc {
        const char *id;
        unsigned long idx;
        int sortable:1;
} gp_widget_table_col_dsc;
 
typedef struct gp_widget_table_col_ops {
        int (*seek_row)(gp_widget *self, int op, unsigned int pos);
        int (*get_cell)(gp_widget *self, gp_widget_table_cell *cell, unsigned int col_idx);
        void (*sort)(gp_widget *self, int desc, unsigned int col_idx);
 
        int (*on_event)(gp_widget_event *ev);
        void *on_event_priv;
 
        gp_widget_table_col_dsc col_map[];
} gp_widget_table_col_ops;
 
typedef struct gp_widget_table_header {
        gp_widget_table_col_dsc *col_dsc;
 
        char *label;
 
        gp_widget_tattr tattr;
 
        unsigned int col_min_size;
        unsigned int col_fill;
} gp_widget_table_header;
 
typedef struct gp_widget_table_col {
        unsigned int size;
        unsigned int min_size;
} gp_widget_table_col;
 
typedef struct gp_widget_table {
        unsigned int cols;
        unsigned int min_rows;
 
        const gp_widget_table_header *header;
        gp_widget_table_col_ops col_ops;
 
        unsigned int selected_row;
        unsigned int sorted_by_col;
        int row_selected:1;
        int sorted_desc:1;
        int needs_header:1;
 
        uint64_t last_click;
 
        unsigned int start_row;
        unsigned int last_rows;
 
        gp_widget_table_col *cols_w;
 
        void *priv;
 
        /* iterator based API */
        union {
                void *row_priv;
                unsigned long row_idx;
        };
 
        void *free;
 
        char buf[];
} gp_widget_table;
 
enum gp_widget_table_event_type {
        GP_WIDGET_TABLE_TRIGGER,
        GP_WIDGET_TABLE_SELECT,
};
 
gp_widget *gp_widget_table_new(unsigned int cols, unsigned int min_rows,
                               const gp_widget_table_col_ops *col_ops,
                               const gp_widget_table_header *header);
 
void gp_widget_table_sort_by(gp_widget *self, int desc, unsigned int col);
 
/*
 * Called when table content has changed and table needs to be rerendered.
 */
void gp_widget_table_refresh(gp_widget *self);
 
/*
 * @brief Sets first row that should be shown by the table.
 *
 * @self A table widget.
 * @off A row offset.
 */
void gp_widget_table_off_set(gp_widget *self, unsigned int off);
 
/*
 * @brief Sets selected row.
 *
 * @self A table widget.
 * @off A row.
 */
void gp_widget_table_sel_set(gp_widget *self, unsigned int row);
 
#endif /* GP_WIDGET_TABLE_H */