1 /**
2  * @file
3  * GUI display the mailboxes in a side panel
4  *
5  * @authors
6  * Copyright (C) 2004 Justin Hibbits <jrh29@po.cwru.edu>
7  * Copyright (C) 2004 Thomer M. Gil <mutt@thomer.com>
8  * Copyright (C) 2015-2020 Richard Russon <rich@flatcap.org>
9  *
10  * @copyright
11  * This program is free software: you can redistribute it and/or modify it under
12  * the terms of the GNU General Public License as published by the Free Software
13  * Foundation, either version 2 of the License, or (at your option) any later
14  * version.
15  *
16  * This program is distributed in the hope that it will be useful, but WITHOUT
17  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
19  * details.
20  *
21  * You should have received a copy of the GNU General Public License along with
22  * this program.  If not, see <http://www.gnu.org/licenses/>.
23  */
24 
25 /**
26  * @page lib_sidebar Sidebar
27  *
28  * Display the mailboxes in a side panel
29  *
30  * | File                | Description                |
31  * | :------------------ | :------------------------- |
32  * | sidebar/commands.c  | @subpage sidebar_commands  |
33  * | sidebar/config.c    | @subpage sidebar_config    |
34  * | sidebar/functions.c | @subpage sidebar_functions |
35  * | sidebar/observer.c  | @subpage sidebar_observers |
36  * | sidebar/sidebar.c   | @subpage sidebar_sidebar   |
37  * | sidebar/sort.c      | @subpage sidebar_sort      |
38  * | sidebar/wdata.c     | @subpage sidebar_wdata     |
39  * | sidebar/window.c    | @subpage sidebar_window    |
40  */
41 
42 #ifndef MUTT_SIDEBAR_LIB_H
43 #define MUTT_SIDEBAR_LIB_H
44 
45 #include <stdbool.h>
46 #include <stdint.h>
47 #include "core/lib.h"
48 
49 struct Buffer;
50 struct MuttWindow;
51 
52 void sb_init    (void);
53 void sb_shutdown(void);
54 
55 void            sb_change_mailbox(struct MuttWindow *win, int op);
56 struct Mailbox *sb_get_highlight (struct MuttWindow *win);
57 
58 enum CommandResult sb_parse_unwhitelist(struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err);
59 enum CommandResult sb_parse_whitelist  (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err);
60 
61 #endif /* MUTT_SIDEBAR_LIB_H */
62