NeoMutt  2024-02-01-23-g345d7b
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
lib.h
Go to the documentation of this file.
1
40#ifndef MUTT_INDEX_LIB_H
41#define MUTT_INDEX_LIB_H
42
43#include <stdbool.h>
44#include <stdint.h>
45#include <stdio.h>
46#include "mutt/lib.h"
47#include "core/lib.h"
48#include "functions.h" // IWYU pragma: keep
49#include "shared_data.h" // IWYU pragma: keep
50
51struct Email;
52struct MailboxView;
53struct Menu;
54struct MuttWindow;
55
56// Observers of #NT_INDEX will be passed an #IndexSharedData.
57typedef uint8_t NotifyIndex;
58#define NT_INDEX_NO_FLAGS 0
59#define NT_INDEX_ADD (1 << 0)
60#define NT_INDEX_DELETE (1 << 1)
61#define NT_INDEX_SUBSET (1 << 2)
62#define NT_INDEX_ACCOUNT (1 << 3)
63#define NT_INDEX_MVIEW (1 << 4)
64#define NT_INDEX_MAILBOX (1 << 5)
65#define NT_INDEX_EMAIL (1 << 6)
66
67typedef uint8_t CheckFlags;
68#define CHECK_NO_FLAGS 0
69#define CHECK_IN_MAILBOX (1 << 0)
70#define CHECK_MSGCOUNT (1 << 1)
71#define CHECK_VISIBLE (1 << 2)
72#define CHECK_READONLY (1 << 3)
73#define CHECK_ATTACH (1 << 4)
74
75extern const struct Mapping IndexNewsHelp[];
76
77void change_folder_mailbox (struct Menu *menu, struct Mailbox *m, int *oldcount, struct IndexSharedData *shared, bool read_only);
78struct Mailbox * change_folder_notmuch (struct Menu *menu, char *buf, int buflen, int *oldcount, struct IndexSharedData *shared, bool read_only);
79void change_folder_string (struct Menu *menu, struct Buffer *buf, int *oldcount, struct IndexSharedData *shared, bool read_only);
80bool check_acl (struct Mailbox *m, AclFlags acl, const char *msg);
81void collapse_all (struct MailboxView *mv, struct Menu *menu, int toggle);
82struct Mailbox * dlg_index (struct MuttWindow *dlg, struct Mailbox *m);
83int find_first_message (struct MailboxView *mv);
84int find_next_undeleted (struct MailboxView *mv, int msgno, bool uncollapse);
85int find_previous_undeleted (struct MailboxView *mv, int msgno, bool uncollapse);
86struct Mailbox * get_current_mailbox (void);
88struct Menu * get_current_menu (void);
89void index_change_folder (struct MuttWindow *dlg, struct Mailbox *m);
90const struct AttrColor *index_color (struct Menu *menu, int line);
91void index_make_entry (struct Menu *menu, int line, struct Buffer *buf);
92struct MuttWindow * index_pager_init (void);
94void mutt_draw_statusline (struct MuttWindow *win, int cols, const char *buf, size_t buflen);
95void mutt_set_header_color (struct Mailbox *m, struct Email *e);
96void resort_index (struct MailboxView *mv, struct Menu *menu);
97void update_index (struct Menu *menu, struct MailboxView *mv, enum MxStatus check, int oldcount, const struct IndexSharedData *shared);
98
99#endif /* MUTT_INDEX_LIB_H */
Convenience wrapper for the core headers.
uint16_t AclFlags
ACL Rights - These show permission to...
Definition: mailbox.h:59
struct Mailbox * dlg_index(struct MuttWindow *dlg, struct Mailbox *m)
Display a list of emails -.
Definition: dlg_index.c:1063
const struct AttrColor * index_color(struct Menu *menu, int line)
Calculate the colour for a line of the index - Implements Menu::color() -.
Definition: dlg_index.c:890
void index_make_entry(struct Menu *menu, int line, struct Buffer *buf)
Format an Email for the Menu - Implements Menu::make_entry() -.
Definition: dlg_index.c:797
bool check_acl(struct Mailbox *m, AclFlags acl, const char *msg)
Check the ACLs for a function.
Definition: dlg_index.c:139
uint8_t CheckFlags
Flags, e.g. CHECK_IN_MAILBOX.
Definition: lib.h:67
const struct Mapping IndexNewsHelp[]
Help Bar for the News Index dialog.
Definition: dlg_index.c:118
void change_folder_mailbox(struct Menu *menu, struct Mailbox *m, int *oldcount, struct IndexSharedData *shared, bool read_only)
Change to a different Mailbox by pointer.
Definition: dlg_index.c:612
struct Mailbox * change_folder_notmuch(struct Menu *menu, char *buf, int buflen, int *oldcount, struct IndexSharedData *shared, bool read_only)
Change to a different Notmuch Mailbox by string.
Definition: dlg_index.c:733
uint8_t NotifyIndex
Flags, e.g. NT_INDEX_ACCOUNT.
Definition: lib.h:57
struct MailboxView * get_current_mailbox_view(void)
Get the current Mailbox view.
Definition: index.c:683
void update_index(struct Menu *menu, struct MailboxView *mv, enum MxStatus check, int oldcount, const struct IndexSharedData *shared)
Update the index.
Definition: dlg_index.c:543
void mutt_set_header_color(struct Mailbox *m, struct Email *e)
Select a colour for a message.
Definition: dlg_index.c:1366
void mutt_draw_statusline(struct MuttWindow *win, int cols, const char *buf, size_t buflen)
Draw a highlighted status bar.
Definition: dlg_index.c:922
struct Mailbox * get_current_mailbox(void)
Get the current Mailbox.
Definition: index.c:715
void index_change_folder(struct MuttWindow *dlg, struct Mailbox *m)
Change the current folder, cautiously.
Definition: dlg_index.c:1425
struct Menu * get_current_menu(void)
Get the current Menu.
Definition: index.c:731
int find_first_message(struct MailboxView *mv)
Get index of first new message.
Definition: dlg_index.c:310
void resort_index(struct MailboxView *mv, struct Menu *menu)
Resort the index.
Definition: dlg_index.c:370
int find_next_undeleted(struct MailboxView *mv, int msgno, bool uncollapse)
Find the next undeleted email.
Definition: dlg_index.c:242
int mutt_dlgindex_observer(struct NotifyCallback *nc)
void collapse_all(struct MailboxView *mv, struct Menu *menu, int toggle)
Collapse/uncollapse all threads.
Definition: dlg_index.c:166
void change_folder_string(struct Menu *menu, struct Buffer *buf, int *oldcount, struct IndexSharedData *shared, bool read_only)
Change to a different Mailbox by string.
Definition: dlg_index.c:758
int find_previous_undeleted(struct MailboxView *mv, int msgno, bool uncollapse)
Find the previous undeleted email.
Definition: dlg_index.c:276
struct MuttWindow * index_pager_init(void)
Allocate the Windows for the Index/Pager.
Definition: dlg_index.c:1397
Data shared between Index, Pager and Sidebar.
Convenience wrapper for the library headers.
MxStatus
Return values from mbox_check(), mbox_check_stats(), mbox_sync(), and mbox_close()
Definition: mxapi.h:63
Sidebar functions.
A curses colour and its attributes.
Definition: attr.h:66
String manipulation buffer.
Definition: buffer.h:36
The envelope/body of an email.
Definition: email.h:39
Data shared between Index, Pager and Sidebar.
Definition: shared_data.h:37
View of a Mailbox.
Definition: mview.h:40
A mailbox.
Definition: mailbox.h:79
Mapping between user-readable string and a constant.
Definition: mapping.h:33
Definition: lib.h:69
Data passed to a notification function.
Definition: observer.h:34