mc/lib/widget/history.h

/** \file lib/widget/history.h
 *  \brief Header: save, load and show history
 */

#ifndef MC__WIDGET_HISTORY_H
#define MC__WIDGET_HISTORY_H

#include "lib/mcconfig.h"       /* mc_config_t */

/*** typedefs(not structures) and defined constants **********************************************/

/* forward declarations */
struct history_descriptor_t;
struct WLEntry;
struct WListbox;

typedef void (*history_create_item_func) (struct history_descriptor_t * hd, void *data);
typedef void *(*history_release_item_func) (struct history_descriptor_t * hd, struct WLEntry * le);

/*** enums ***************************************************************************************/

/*** structures declarations (and typedefs of structures)*****************************************/

typedef struct history_descriptor_t
{
    GList *list;                /**< list with history items */
    int y;                      /**< y-coordinate to place history window */
    int x;                      /**< x-coordinate to place history window */
    int current;                /**< initially selected item in the history */
    int action;                 /**< return action in the history */
    char *text;                 /**< return text of selected item */

    size_t max_width;           /**< maximum width of sring in history */
    struct WListbox *listbox;   /**< listbox widget to draw history */

    history_create_item_func create;    /**< function to create item of @list */
    history_release_item_func release;  /**< function to release item of @list */
    GDestroyNotify free;        /**< function to destroy element of @list */
} history_descriptor_t;

/*** global variables defined in .c file *********************************************************/

extern int num_history_items_recorded;

/*** declarations of public functions ************************************************************/

/* read history to the mc_config, but don't save config to file */
GList *history_get (const char *input_name);
/* load history from the mc_config */
GList *history_load (mc_config_t * cfg, const char *name);
/* save history to the mc_config, but don't save config to file */
void history_save (mc_config_t * cfg, const char *name, GList * h);

void history_descriptor_init (history_descriptor_t * hd, int y, int x, GList * history,
                              int current);

/* for repositioning of history dialog we should pass widget to this
 * function, as position of history dialog depends on widget's position */
void history_show (history_descriptor_t * hd);

/*** inline functions ****************************************************************************/

#endif /* MC__WIDGET_HISTORY_H */