2 Widgets for the Midnight Commander
4 Copyright (C) 1994, 1995, 1996, 1998, 1999, 2000, 2001, 2002, 2003,
5 2004, 2005, 2006, 2007, 2009, 2010, 2011
6 The Free Software Foundation, Inc.
9 Radek Doulik, 1994, 1995
10 Miguel de Icaza, 1994, 1995
12 Andrej Borsenkow, 1996
14 Andrew Borodin <aborodin@vmail.ru>, 2009, 2010
16 This file is part of the Midnight Commander.
18 The Midnight Commander is free software: you can redistribute it
19 and/or modify it under the terms of the GNU General Public License as
20 published by the Free Software Foundation, either version 3 of the License,
21 or (at your option) any later version.
23 The Midnight Commander is distributed in the hope that it will be useful,
24 but WITHOUT ANY WARRANTY; without even the implied warranty of
25 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 GNU General Public License for more details.
28 You should have received a copy of the GNU General Public License
29 along with this program. If not, see <http://www.gnu.org/licenses/>.
33 * \brief Source: WListbox widget
40 #include "lib/global.h"
42 #include "lib/tty/tty.h"
43 #include "lib/tty/mouse.h"
45 #include "lib/strutil.h"
46 #include "lib/util.h" /* Q_() */
47 #include "lib/keybind.h" /* global_keymap_t */
48 #include "lib/widget.h"
50 /*** global variables ****************************************************************************/
52 const global_keymap_t
*listbox_map
= NULL
;
54 /*** file scope macro definitions ****************************************************************/
56 /*** file scope type declarations ****************************************************************/
58 /*** file scope variables ************************************************************************/
60 /*** file scope functions ************************************************************************/
63 listbox_entry_cmp (const void *a
, const void *b
)
65 const WLEntry
*ea
= (const WLEntry
*) a
;
66 const WLEntry
*eb
= (const WLEntry
*) b
;
68 return strcmp (ea
->text
, eb
->text
);
71 /* --------------------------------------------------------------------------------------------- */
74 listbox_entry_free (void *data
)
81 /* --------------------------------------------------------------------------------------------- */
84 listbox_drawscroll (WListbox
* l
)
86 const int max_line
= l
->widget
.lines
- 1;
90 /* Are we at the top? */
91 widget_move (&l
->widget
, 0, l
->widget
.cols
);
93 tty_print_one_vline (TRUE
);
97 /* Are we at the bottom? */
98 widget_move (&l
->widget
, max_line
, l
->widget
.cols
);
99 if ((l
->top
+ l
->widget
.lines
== l
->count
) || (l
->widget
.lines
>= l
->count
))
100 tty_print_one_vline (TRUE
);
102 tty_print_char ('v');
104 /* Now draw the nice relative pointer */
106 line
= 1 + ((l
->pos
* (l
->widget
.lines
- 2)) / l
->count
);
108 for (i
= 1; i
< max_line
; i
++)
110 widget_move (&l
->widget
, i
, l
->widget
.cols
);
112 tty_print_one_vline (TRUE
);
114 tty_print_char ('*');
118 /* --------------------------------------------------------------------------------------------- */
121 listbox_draw (WListbox
* l
, gboolean focused
)
123 const Dlg_head
*h
= l
->widget
.owner
;
124 const gboolean disabled
= (((Widget
*) l
)->options
& W_DISABLED
) != 0;
125 const int normalc
= disabled
? DISABLED_COLOR
: h
->color
[DLG_COLOR_NORMAL
];
127 disabled
? DISABLED_COLOR
: focused
? h
->
128 color
[DLG_COLOR_HOT_FOCUS
] : h
->color
[DLG_COLOR_FOCUS
];
135 le
= g_list_nth (l
->list
, l
->top
);
136 /* pos = (le == NULL) ? 0 : g_list_position (l->list, le); */
137 pos
= (le
== NULL
) ? 0 : l
->top
;
139 for (i
= 0; i
< l
->widget
.lines
; i
++)
143 /* Display the entry */
144 if (pos
== l
->pos
&& sel_line
== -1)
150 tty_setcolor (normalc
);
152 widget_move (&l
->widget
, i
, 1);
154 if ((i
> 0 && pos
>= l
->count
) || (l
->list
== NULL
) || (le
== NULL
))
158 WLEntry
*e
= (WLEntry
*) le
->data
;
160 le
= g_list_next (le
);
164 tty_print_string (str_fit_to_term (text
, l
->widget
.cols
- 2, J_LEFT_FIT
));
167 l
->cursor_y
= sel_line
;
169 if (l
->scrollbar
&& (l
->count
> l
->widget
.lines
))
171 tty_setcolor (normalc
);
172 listbox_drawscroll (l
);
176 /* --------------------------------------------------------------------------------------------- */
179 listbox_check_hotkey (WListbox
* l
, int key
)
184 for (i
= 0, le
= l
->list
; le
!= NULL
; i
++, le
= g_list_next (le
))
186 WLEntry
*e
= (WLEntry
*) le
->data
;
188 if (e
->hotkey
== key
)
195 /* --------------------------------------------------------------------------------------------- */
197 /* Selects from base the pos element */
199 listbox_select_pos (WListbox
* l
, int base
, int pos
)
201 int last
= l
->count
- 1;
204 base
= min (base
, last
);
209 /* --------------------------------------------------------------------------------------------- */
212 listbox_fwd (WListbox
* l
)
214 if (l
->pos
+ 1 >= l
->count
)
215 listbox_select_first (l
);
217 listbox_select_entry (l
, l
->pos
+ 1);
220 /* --------------------------------------------------------------------------------------------- */
223 listbox_back (WListbox
* l
)
226 listbox_select_last (l
);
228 listbox_select_entry (l
, l
->pos
- 1);
231 /* --------------------------------------------------------------------------------------------- */
234 listbox_execute_cmd (WListbox
* l
, unsigned long command
)
236 cb_ret_t ret
= MSG_HANDLED
;
248 listbox_select_first (l
);
251 listbox_select_last (l
);
254 for (i
= 0; (i
< l
->widget
.lines
- 1) && (l
->pos
> 0); i
++)
258 for (i
= 0; (i
< l
->widget
.lines
- 1) && (l
->pos
< l
->count
- 1); i
++)
264 gboolean is_last
= (l
->pos
+ 1 >= l
->count
);
265 gboolean is_more
= (l
->top
+ l
->widget
.lines
>= l
->count
);
267 listbox_remove_current (l
);
268 if ((l
->top
> 0) && (is_last
|| is_more
))
273 if (l
->deletable
&& mc_global
.widget
.confirm_history_cleanup
274 /* TRANSLATORS: no need to translate 'DialogTitle', it's just a context prefix */
275 && (query_dialog (Q_ ("DialogTitle|History cleanup"),
276 _("Do you want clean this history?"),
277 D_ERROR
, 2, _("&Yes"), _("&No")) == 0))
278 listbox_remove_list (l
);
281 ret
= MSG_NOT_HANDLED
;
287 /* --------------------------------------------------------------------------------------------- */
289 /* Return MSG_HANDLED if we want a redraw */
291 listbox_key (WListbox
* l
, int key
)
293 unsigned long command
;
296 return MSG_NOT_HANDLED
;
298 /* focus on listbox item N by '0'..'9' keys */
299 if (key
>= '0' && key
<= '9')
302 listbox_select_entry (l
, key
- '0');
304 /* need scroll to item? */
305 if (abs (oldpos
- l
->pos
) > l
->widget
.lines
)
311 command
= keybind_lookup_keymap_command (listbox_map
, key
);
312 if (command
== CK_IgnoreKey
)
313 return MSG_NOT_HANDLED
;
314 return listbox_execute_cmd (l
, command
);
317 /* --------------------------------------------------------------------------------------------- */
319 /* Listbox item adding function */
321 listbox_append_item (WListbox
* l
, WLEntry
* e
, listbox_append_t pos
)
325 case LISTBOX_APPEND_AT_END
:
326 l
->list
= g_list_append (l
->list
, e
);
329 case LISTBOX_APPEND_BEFORE
:
330 l
->list
= g_list_insert_before (l
->list
, g_list_nth (l
->list
, l
->pos
), e
);
335 case LISTBOX_APPEND_AFTER
:
336 l
->list
= g_list_insert (l
->list
, e
, l
->pos
+ 1);
339 case LISTBOX_APPEND_SORTED
:
340 l
->list
= g_list_insert_sorted (l
->list
, e
, (GCompareFunc
) listbox_entry_cmp
);
350 /* --------------------------------------------------------------------------------------------- */
353 listbox_destroy (WListbox
* l
)
355 listbox_remove_list (l
);
358 /* --------------------------------------------------------------------------------------------- */
361 listbox_callback (Widget
* w
, widget_msg_t msg
, int parm
)
363 WListbox
*l
= (WListbox
*) w
;
364 Dlg_head
*h
= l
->widget
.owner
;
376 pos
= listbox_check_hotkey (l
, parm
);
378 return MSG_NOT_HANDLED
;
380 listbox_select_entry (l
, pos
);
381 h
->callback (h
, w
, DLG_ACTION
, l
->pos
, NULL
);
383 if (l
->callback
!= NULL
)
384 action
= l
->callback (l
);
386 action
= LISTBOX_DONE
;
388 if (action
== LISTBOX_DONE
)
390 h
->ret_value
= B_ENTER
;
398 ret_code
= listbox_key (l
, parm
);
399 if (ret_code
!= MSG_NOT_HANDLED
)
401 listbox_draw (l
, TRUE
);
402 h
->callback (h
, w
, DLG_ACTION
, l
->pos
, NULL
);
407 return listbox_execute_cmd (l
, parm
);
410 widget_move (&l
->widget
, l
->cursor_y
, 0);
411 h
->callback (h
, w
, DLG_ACTION
, l
->pos
, NULL
);
417 listbox_draw (l
, msg
!= WIDGET_UNFOCUS
);
428 return default_proc (msg
, parm
);
432 /* --------------------------------------------------------------------------------------------- */
435 listbox_event (Gpm_Event
* event
, void *data
)
437 WListbox
*l
= (WListbox
*) data
;
438 Widget
*w
= (Widget
*) data
;
440 if (!mouse_global_in_widget (event
, w
))
441 return MOU_UNHANDLED
;
444 if ((event
->type
& GPM_DOWN
) != 0)
445 dlg_select_widget (l
);
450 if ((event
->type
& (GPM_DOWN
| GPM_DRAG
)) != 0)
452 int ret
= MOU_REPEAT
;
456 local
= mouse_get_local (event
, w
);
458 for (i
= -local
.y
; i
>= 0; i
--)
460 else if (local
.y
> w
->lines
)
461 for (i
= local
.y
- w
->lines
; i
> 0; i
--)
463 else if ((local
.buttons
& GPM_B_UP
) != 0)
468 else if ((local
.buttons
& GPM_B_DOWN
) != 0)
474 listbox_select_entry (l
, listbox_select_pos (l
, l
->top
, local
.y
- 1));
476 /* We need to refresh ourselves since the dialog manager doesn't */
477 /* know about this event */
478 listbox_draw (l
, TRUE
);
483 if ((event
->type
& (GPM_DOUBLE
| GPM_UP
)) == (GPM_UP
| GPM_DOUBLE
))
488 local
= mouse_get_local (event
, w
);
489 dlg_select_widget (l
);
490 listbox_select_entry (l
, listbox_select_pos (l
, l
->top
, local
.y
- 1));
492 if (l
->callback
!= NULL
)
493 action
= l
->callback (l
);
495 action
= LISTBOX_DONE
;
497 if (action
== LISTBOX_DONE
)
499 w
->owner
->ret_value
= B_ENTER
;
507 /* --------------------------------------------------------------------------------------------- */
508 /*** public functions ****************************************************************************/
509 /* --------------------------------------------------------------------------------------------- */
512 listbox_new (int y
, int x
, int height
, int width
, gboolean deletable
, lcback_fn callback
)
519 l
= g_new (WListbox
, 1);
520 init_widget (&l
->widget
, y
, x
, height
, width
, listbox_callback
, listbox_event
);
525 l
->deletable
= deletable
;
526 l
->callback
= callback
;
527 l
->allow_duplicates
= TRUE
;
528 l
->scrollbar
= !mc_global
.tty
.slow_terminal
;
529 widget_want_hotkey (l
->widget
, TRUE
);
530 widget_want_cursor (l
->widget
, FALSE
);
535 /* --------------------------------------------------------------------------------------------- */
538 listbox_search_text (WListbox
* l
, const char *text
)
545 for (i
= 0, le
= l
->list
; le
!= NULL
; i
++, le
= g_list_next (le
))
547 WLEntry
*e
= (WLEntry
*) le
->data
;
549 if (strcmp (e
->text
, text
) == 0)
557 /* --------------------------------------------------------------------------------------------- */
559 /* Selects the first entry and scrolls the list to the top */
561 listbox_select_first (WListbox
* l
)
566 /* --------------------------------------------------------------------------------------------- */
568 /* Selects the last entry and scrolls the list to the bottom */
570 listbox_select_last (WListbox
* l
)
572 l
->pos
= l
->count
- 1;
573 l
->top
= l
->count
> l
->widget
.lines
? l
->count
- l
->widget
.lines
: 0;
576 /* --------------------------------------------------------------------------------------------- */
579 listbox_select_entry (WListbox
* l
, int dest
)
583 gboolean top_seen
= FALSE
;
589 for (pos
= 0, le
= l
->list
; le
!= NULL
; pos
++, le
= g_list_next (le
))
599 else if (l
->pos
- l
->top
>= l
->widget
.lines
)
600 l
->top
= l
->pos
- l
->widget
.lines
+ 1;
605 /* If we are unable to find it, set decent values */
609 /* --------------------------------------------------------------------------------------------- */
611 /* Returns the current string text as well as the associated extra data */
613 listbox_get_current (WListbox
* l
, char **string
, void **extra
)
619 e
= (WLEntry
*) g_list_nth_data (l
->list
, l
->pos
);
624 *string
= ok
? e
->text
: NULL
;
627 *extra
= ok
? e
->data
: NULL
;
630 /* --------------------------------------------------------------------------------------------- */
633 listbox_remove_current (WListbox
* l
)
635 if ((l
!= NULL
) && (l
->count
!= 0))
639 current
= g_list_nth (l
->list
, l
->pos
);
640 l
->list
= g_list_remove_link (l
->list
, current
);
641 listbox_entry_free ((WLEntry
*) current
->data
);
642 g_list_free_1 (current
);
647 else if (l
->pos
>= l
->count
)
648 l
->pos
= l
->count
- 1;
652 /* --------------------------------------------------------------------------------------------- */
655 listbox_set_list (WListbox
* l
, GList
* list
)
657 listbox_remove_list (l
);
663 l
->count
= g_list_length (list
);
667 /* --------------------------------------------------------------------------------------------- */
670 listbox_remove_list (WListbox
* l
)
672 if ((l
!= NULL
) && (l
->count
!= 0))
674 g_list_foreach (l
->list
, (GFunc
) listbox_entry_free
, NULL
);
675 g_list_free (l
->list
);
677 l
->count
= l
->pos
= l
->top
= 0;
681 /* --------------------------------------------------------------------------------------------- */
684 listbox_add_item (WListbox
* l
, listbox_append_t pos
, int hotkey
, const char *text
, void *data
)
691 if (!l
->allow_duplicates
&& (listbox_search_text (l
, text
) >= 0))
694 entry
= g_new (WLEntry
, 1);
695 entry
->text
= g_strdup (text
);
697 entry
->hotkey
= hotkey
;
699 listbox_append_item (l
, entry
, pos
);
704 /* --------------------------------------------------------------------------------------------- */