NeoMutt  2021-02-05-666-ge300cd
Teaching an old dog new tricks
DOXYGEN
lib.h File Reference

Help Bar Convenience wrapper for the Help Bar headers. More...

+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

struct MuttWindowhelpbar_new (void)
 Create the Help Bar Window. More...
 

Detailed Description

Help Bar Convenience wrapper for the Help Bar headers.

Authors
  • Richard Russon

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file lib.h.

Function Documentation

◆ helpbar_new()

struct MuttWindow* helpbar_new ( void  )

Create the Help Bar Window.

Return values
ptrNew Window
Note
The Window can be freed with mutt_window_free().

Definition at line 327 of file helpbar.c.

328 {
329  struct MuttWindow *win =
332  win->state.visible = cs_subset_bool(NeoMutt->sub, "help");
333 
334  win->recalc = helpbar_recalc;
335  win->repaint = helpbar_repaint;
336 
337  win->wdata = helpbar_wdata_new();
339 
344  return win;
345 }
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:73
void(* wdata_free)(struct MuttWindow *win, void **ptr)
Definition: mutt_window.h:160
Window uses all available vertical space.
Definition: mutt_window.h:38
struct HelpbarWindowData * helpbar_wdata_new(void)
Create new Window data for the Helpbar.
Definition: wdata.c:39
Container for Accounts, Notifications.
Definition: neomutt.h:36
MuttWindow has changed, NotifyWindow, EventWindow.
Definition: notify_type.h:53
struct Notify * notify
Notifications: NotifyWindow, EventWindow.
Definition: mutt_window.h:138
static int helpbar_config_observer(struct NotifyCallback *nc)
Notification that a Config Variable has changed - Implements observer_t.
Definition: helpbar.c:256
Key binding has changed, NotifyBinding, EventBinding.
Definition: notify_type.h:38
bool notify_observer_add(struct Notify *notify, enum NotifyType type, observer_t callback, void *global_data)
Add an observer to an object.
Definition: notify.c:189
Window has a fixed size.
Definition: mutt_window.h:47
static int helpbar_color_observer(struct NotifyCallback *nc)
Notification that a Color has changed - Implements observer_t.
Definition: helpbar.c:232
Colour has changed, NotifyColor, EventColor.
Definition: notify_type.h:39
struct WindowState state
Current state of the Window.
Definition: mutt_window.h:127
bool visible
Window is visible.
Definition: mutt_window.h:59
#define MUTT_WIN_SIZE_UNLIMITED
Use as much space as possible.
Definition: mutt_window.h:52
Help Bar containing list of useful key bindings.
Definition: mutt_window.h:96
struct Notify * notify
Notifications handler.
Definition: neomutt.h:38
Config has changed, NotifyConfig, EventConfig.
Definition: notify_type.h:42
static int helpbar_window_observer(struct NotifyCallback *nc)
Notification that a Window has changed - Implements observer_t.
Definition: helpbar.c:282
struct MuttWindow * RootWindow
Parent of all Windows.
Definition: rootwin.c:105
void helpbar_wdata_free(struct MuttWindow *win, void **ptr)
Free Helpbar Window data - Implements MuttWindow::wdata_free() -.
Definition: wdata.c:47
int(* repaint)(struct MuttWindow *win)
Definition: mutt_window.h:182
static int helpbar_recalc(struct MuttWindow *win)
Recalculate the display of the Help Bar - Implements MuttWindow::recalc() -Generate the help string f...
Definition: helpbar.c:143
int(* recalc)(struct MuttWindow *win)
Definition: mutt_window.h:171
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:39
static int helpbar_repaint(struct MuttWindow *win)
Redraw the Help Bar - Implements MuttWindow::repaint() -The Help Bar is drawn from the data cached in...
Definition: helpbar.c:180
struct MuttWindow * mutt_window_new(enum WindowType type, enum MuttWindowOrientation orient, enum MuttWindowSize size, int cols, int rows)
Create a new Window.
Definition: mutt_window.c:180
void * wdata
Private data.
Definition: mutt_window.h:145
static int helpbar_binding_observer(struct NotifyCallback *nc)
Notification that a Key Binding has changed - Implements observer_t.
Definition: helpbar.c:204
+ Here is the call graph for this function:
+ Here is the caller graph for this function: