3 * \brief Header: WListbox widget
6 #ifndef MC__WIDGET_LISTBOX_H
7 #define MC__WIDGET_LISTBOX_H
9 #include "lib/keybind.h" /* global_keymap_t */
11 /*** typedefs(not structures) and defined constants **********************************************/
13 #define LISTBOX(x) ((WListbox *)(x))
14 #define LENTRY(x) ((WLEntry *)(x))
16 /*** enums ***************************************************************************************/
18 /* callback should return one of the following values */
21 LISTBOX_CONT
, /* continue */
22 LISTBOX_DONE
/* finish dialog */
27 LISTBOX_APPEND_AT_END
= 0, /* append at the end */
28 LISTBOX_APPEND_BEFORE
, /* insert before current */
29 LISTBOX_APPEND_AFTER
, /* insert after current */
30 LISTBOX_APPEND_SORTED
/* insert alphabetically */
33 /*** structures declarations (and typedefs of structures)*****************************************/
36 typedef lcback_ret_t (*lcback_fn
) (struct WListbox
* l
);
38 typedef struct WLEntry
40 char *text
; /* Text to display */
42 void *data
; /* Client information */
43 gboolean free_data
; /* Whether to free the data on entry's removal */
46 typedef struct WListbox
49 GQueue
*list
; /* Pointer to the list of WLEntry */
50 int pos
; /* The current element displayed */
51 int top
; /* The first element displayed */
52 gboolean allow_duplicates
; /* Do we allow duplicates on the list? */
53 gboolean scrollbar
; /* Draw a scrollbar? */
54 gboolean deletable
; /* Can list entries be deleted? */
55 gboolean focused
; /* Listbox is focused */
56 lcback_fn callback
; /* The callback function */
57 int cursor_x
, cursor_y
; /* Cache the values */
60 /*** global variables defined in .c file *********************************************************/
62 extern const global_keymap_t
*listbox_map
;
64 /*** declarations of public functions ************************************************************/
66 WListbox
*listbox_new (int y
, int x
, int height
, int width
, gboolean deletable
, lcback_fn callback
);
67 int listbox_search_text (WListbox
* l
, const char *text
);
68 void listbox_select_first (WListbox
* l
);
69 void listbox_select_last (WListbox
* l
);
70 void listbox_select_entry (WListbox
* l
, int dest
);
71 void listbox_get_current (WListbox
* l
, char **string
, void **extra
);
72 WLEntry
*listbox_get_nth_item (const WListbox
* l
, int pos
);
73 GList
*listbox_get_first_link (const WListbox
* l
);
74 void listbox_remove_current (WListbox
* l
);
75 gboolean
listbox_is_empty (const WListbox
* l
);
76 void listbox_set_list (WListbox
* l
, GList
* list
);
77 void listbox_remove_list (WListbox
* l
);
78 char *listbox_add_item (WListbox
* l
, listbox_append_t pos
, int hotkey
, const char *text
,
79 void *data
, gboolean free_data
);
81 /*** inline functions ****************************************************************************/
83 #endif /* MC__WIDGET_LISTBOX_H */