1 /***************************************************************************
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
10 * Copyright (C) 2005 by Kevin Ferrare
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version 2
15 * of the License, or (at your option) any later version.
17 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
18 * KIND, either express or implied.
20 ****************************************************************************/
27 #include "screen_access.h"
28 #include "skin_engine/skin_engine.h"
30 #define SCROLLBAR_WIDTH global_settings.scrollbar_width
35 LIST_WRAP_UNLESS_HELD
,
39 * The gui_list is based on callback functions, if you want the list
40 * to display something you have to provide it a function that
41 * tells it what to display.
42 * There are three callback function :
43 * one to get the text, one to get the icon and one to get the color
48 * - selected_item : an integer that tells the number of the item to display
49 * - data : a void pointer to the data you gave to the list when you
51 * Returns a pointer to the icon, the value inside it is used to display the
52 * icon after the function returns.
53 * Note : we use the ICON type because the real type depends of the plateform
55 typedef enum themable_icons
list_get_icon(int selected_item
, void * data
);
58 * - selected_item : an integer that tells the number of the item to display
59 * - data : a void pointer to the data you gave to the list when you
61 * - buffer : a buffer to put the resulting text on it
62 * (The content of the buffer may not be used by the list, we use
63 * the return value of the function in all cases to avoid filling
64 * a buffer when it's not necessary)
65 * - buffer_len : length of the buffer
66 * Returns a pointer to a string that contains the text to display
68 typedef const char * list_get_name(int selected_item
, void * data
,
69 char * buffer
, size_t buffer_len
);
72 * - selected_item : an integer that tells the number of the item to speak
73 * - data : a void pointer to the data you gave to the list when you
75 * Returns an integer, 0 means success, ignored really...
77 typedef int list_speak_item(int selected_item
, void * data
);
81 * - selected_item : an integer that tells the number of the item to display
82 * - data : a void pointer to the data you gave to the list when you
84 * Returns an int with the lower 16 bits representing the color to display the
85 * selected item, negative value for default coloring.
87 typedef int list_get_color(int selected_item
, void * data
);
92 /* defines wether the list should stop when reaching the top/bottom
93 * or should continue (by going to bottom/top) */
95 /* wether the text of the whole items of the list have to be
96 * scrolled or only for the selected item */
100 int start_item
[NB_SCREENS
]; /* the item that is displayed at the top of the screen */
101 /* the number of lines that are selected at the same time */
103 #ifdef HAVE_LCD_BITMAP
104 int offset_position
[NB_SCREENS
]; /* the list's screen scroll placement in pixels */
106 long scheduled_talk_tick
, last_talked_tick
;
108 list_get_icon
*callback_get_item_icon
;
109 list_get_name
*callback_get_item_name
;
110 list_speak_item
*callback_speak_item
;
112 /* The data that will be passed to the callback function YOU implement */
114 /* The optional title, set to NULL for none */
116 /* Optional title icon */
117 enum themable_icons title_icon
;
118 bool show_selection_marker
; /* set to true by default */
120 #ifdef HAVE_LCD_COLOR
122 list_get_color
*callback_get_item_color
;
124 struct viewport
*parent
[NB_SCREENS
];
128 #ifdef HAVE_LCD_BITMAP
129 extern void list_init(void);
130 /* parse global setting to static int */
131 extern void gui_list_screen_scroll_step(int ofs
);
133 /* parse global setting to static bool */
134 extern void gui_list_screen_scroll_out_of_view(bool enable
);
135 #endif /* HAVE_LCD_BITMAP */
137 extern void gui_synclist_init(
138 struct gui_synclist
* lists
,
139 list_get_name callback_get_item_name
,
143 struct viewport parent
[NB_SCREENS
] /* NOTE: new screens should NOT set this to NULL */
145 extern void gui_synclist_set_nb_items(struct gui_synclist
* lists
, int nb_items
);
146 extern void gui_synclist_set_icon_callback(struct gui_synclist
* lists
, list_get_icon icon_callback
);
147 extern void gui_synclist_set_voice_callback(struct gui_synclist
* lists
, list_speak_item voice_callback
);
148 #ifdef HAVE_LCD_COLOR
149 extern void gui_synclist_set_color_callback(struct gui_synclist
* lists
, list_get_color color_callback
);
151 extern void gui_synclist_speak_item(struct gui_synclist
* lists
);
152 extern int gui_synclist_get_nb_items(struct gui_synclist
* lists
);
154 extern int gui_synclist_get_sel_pos(struct gui_synclist
* lists
);
156 extern void gui_synclist_draw(struct gui_synclist
* lists
);
157 extern void gui_synclist_scroll_stop(struct gui_synclist
*lists
);
158 extern void gui_synclist_select_item(struct gui_synclist
* lists
,
160 extern void gui_synclist_add_item(struct gui_synclist
* lists
);
161 extern void gui_synclist_del_item(struct gui_synclist
* lists
);
162 extern void gui_synclist_limit_scroll(struct gui_synclist
* lists
, bool scroll
);
163 extern void gui_synclist_set_title(struct gui_synclist
* lists
, char * title
,
164 enum themable_icons icon
);
165 extern void gui_synclist_hide_selection_marker(struct gui_synclist
*lists
,
167 extern bool gui_synclist_item_is_onscreen(struct gui_synclist
*lists
,
168 enum screen_type screen
, int item
);
170 * Do the action implied by the given button,
171 * returns true if the action was handled.
172 * NOTE: *action may be changed regardless of return value
174 extern bool gui_synclist_do_button(struct gui_synclist
* lists
,
177 #if defined(HAVE_LCD_BITMAP) && !defined(PLUGIN)
178 struct listitem_viewport_cfg
{
179 struct wps_data
*data
;
186 struct skin_viewport selected_item_vp
;
188 bool skinlist_draw(struct screen
*display
, struct gui_synclist
*list
);
189 bool skinlist_is_selected_item(void);
190 void skinlist_set_cfg(enum screen_type screen
,
191 struct listitem_viewport_cfg
*cfg
);
192 const char* skinlist_get_item_text(void);
193 enum themable_icons
skinlist_get_item_icon(void);
194 bool skinlist_needs_scrollbar(enum screen_type screen
);
195 void skinlist_get_scrollbar(int* nb_item
, int* first_shown
, int* last_shown
);
196 int skinlist_get_line_count(enum screen_type screen
, struct gui_synclist
*list
);
199 #if defined(HAVE_TOUCHSCREEN)
200 /* this needs to be fixed if we ever get more than 1 touchscreen on a target */
201 extern unsigned gui_synclist_do_touchscreen(struct gui_synclist
* gui_list
);
202 /* only for private use in gui/list.c */
203 extern void _gui_synclist_stop_kinetic_scrolling(void);
206 /* If the list has a pending postponed scheduled announcement, that
207 may become due before the next get_action tmieout. This function
208 adjusts the get_action timeout appropriately. */
209 extern int list_do_action_timeout(struct gui_synclist
*lists
, int timeout
);
210 /* This one combines a get_action call (with timeout overridden by
211 list_do_action_timeout) with the gui_synclist_do_button call, for
213 extern bool list_do_action(int context
, int timeout
,
214 struct gui_synclist
*lists
, int *action
,
215 enum list_wrap wrap
);
218 /** Simplelist implementation.
219 USe this if you dont need to reimplement the list code,
220 and just need to show a list
223 struct simplelist_info
{
224 char *title
; /* title to show on the list */
225 int count
; /* number of items in the list, each item is selection_size high */
226 int selection_size
; /* list selection size, usually 1 */
230 int selection
; /* the item to select when the list is first displayed */
231 /* when the list is exited, this will be set to the
232 index of the last item selected, or -1 if the list
233 was exited with ACTION_STD_CANCEL */
234 int (*action_callback
)(int action
, struct gui_synclist
*lists
); /* can be NULL */
235 /* action_callback notes:
236 action == the action pressed by the user
237 _after_ gui_synclist_do_button returns.
238 lists == the lists struct so the callback can get selection and count etc. */
239 enum themable_icons title_icon
;
240 list_get_icon
*get_icon
; /* can be NULL */
241 list_get_name
*get_name
; /* NULL if you're using simplelist_addline() */
242 list_speak_item
*get_talk
; /* can be NULL to not speak */
243 #ifdef HAVE_LCD_COLOR
244 list_get_color
*get_color
;
246 void *callback_data
; /* data for callbacks */
249 #define SIMPLELIST_MAX_LINES 32
250 #define SIMPLELIST_MAX_LINELENGTH 32
252 /** The next three functions are used if the text is mostly static.
253 These should be called in the action callback for the list.
255 /* set the amount of lines shown in the list
256 Only needed if simplelist_info.get_name == NULL */
257 void simplelist_set_line_count(int lines
);
258 /* get the current amount of lines shown */
259 int simplelist_get_line_count(void);
260 /* add/edit a line in the list.
261 if line_number > number of lines shown it adds the line, else it edits the line */
262 #define SIMPLELIST_ADD_LINE (SIMPLELIST_MAX_LINES+1)
263 void simplelist_addline(int line_number
, const char *fmt
, ...);
265 /* setup the info struct. members not setup in this function need to be assigned manually
266 members set in this function:
267 info.selection_size = 1;
268 info.hide_selection = false;
269 info.scroll_all = false;
270 info.action_callback = NULL;
271 info.title_icon = Icon_NOICON;
272 info.get_icon = NULL;
273 info.get_name = NULL;
274 info.get_voice = NULL;
275 info.get_color = NULL;
276 info.timeout = HZ/10;
279 void simplelist_info_init(struct simplelist_info
*info
, char* title
,
280 int count
, void* data
);
283 if list->action_callback != NULL it is called with the action ACTION_REDRAW
284 before the list is dislplayed for the first time */
285 bool simplelist_show_list(struct simplelist_info
*info
);
287 #endif /* _GUI_LIST_H_ */