log_view::HelpPanel Class Reference

#include <help_panel.h>

Inheritance diagram for log_view::HelpPanel:

Public Member Functions
virtual bool	handleKey (int key)
virtual bool	handleMouse (const MEVENT &event)
	HelpPanel (int height, int width, int y, int x)
virtual void	refresh ()
virtual void	resize (int height, int width, int y, int x)
virtual	~HelpPanel ()
Public Member Functions inherited from log_view::PanelInterface
virtual bool	encloses (int y, int x)
virtual bool	focus () const
virtual void	forceRefresh ()
virtual bool	handleInput (int key)
virtual bool	handleNavigation (int key)
virtual int	height () const
virtual bool	hidden () const
virtual void	hide (bool enable)
	PanelInterface (int height, int width, int y, int x)
virtual bool	scrollbar () const
virtual bool	setCursor ()
virtual bool	setFocus (bool enable)
virtual void	toTop ()
virtual bool	visible () const
virtual int	width () const
virtual int	x () const
virtual int	y () const
virtual	~PanelInterface ()

Protected Member Functions
virtual bool	canNavigate () const
void	printKeybinding (const HelpText &text)
Protected Member Functions inherited from log_view::PanelInterface
virtual void	activate (bool enable)
virtual bool	canFocus () const
virtual bool	canInput () const
virtual bool	canSelect () const
virtual void	drawScrollBar (size_t count, int height, int y, int x)
virtual void	follow (bool enable)
virtual bool	following ()
virtual int	getContentHeight () const
virtual size_t	getContentSize () const
virtual int	getContentWidth () const
virtual int64_t	getCursor () const
virtual int	inputOffset () const
virtual void	move (int step)
virtual void	moveTo (size_t index)
virtual void	pageDown ()
virtual void	pageUp ()
virtual void	select ()
virtual void	setCursor (int64_t cursor)
virtual void	shift (int cols)

Protected Attributes
std::vector< HelpText >	keys_
size_t	longest_key_ = 0
size_t	longest_line_ = 0
Protected Attributes inherited from log_view::PanelInterface
bool	cleared_ = false
bool	focus_ = false
bool	follow_ = true
int	height_
bool	hidden_ = false
int	input_loc_ = -1
std::string	input_text_
size_t	last_content_size_ = 0
int64_t	last_cursor_ = 0
size_t	max_length_ = 0
PANEL *	panel_ = nullptr
int	shift_ = 0
int	width_
WINDOW *	window_ = nullptr
int	x_
int	y_

Detailed Description

Definition at line 44 of file help_panel.h.

Constructor & Destructor Documentation

log_view::HelpPanel::HelpPanel	(	int	height,
		int	width,
		int	y,
		int	x
	)

Definition at line 39 of file help_panel.cpp.

virtual log_view::HelpPanel::~HelpPanel ( )

inlinevirtual

Definition at line 47 of file help_panel.h.

Member Function Documentation

virtual bool log_view::HelpPanel::canNavigate ( ) const

inlineprotectedvirtual

Reimplemented from log_view::PanelInterface.

Definition at line 54 of file help_panel.h.

bool log_view::HelpPanel::handleKey ( int  key )

virtual

Reimplemented from log_view::PanelInterface.

Definition at line 86 of file help_panel.cpp.

virtual bool log_view::HelpPanel::handleMouse ( const MEVENT &  event )

inlinevirtual

Reimplemented from log_view::PanelInterface.

Definition at line 50 of file help_panel.h.

void log_view::HelpPanel::printKeybinding ( const HelpText &  text )

protected

Definition at line 101 of file help_panel.cpp.

void log_view::HelpPanel::refresh ( )

virtual

Implements log_view::PanelInterface.

Definition at line 69 of file help_panel.cpp.

void log_view::HelpPanel::resize ( int  height, int  width, int  y, int  x  )

virtual

Reimplemented from log_view::PanelInterface.

Definition at line 77 of file help_panel.cpp.

Member Data Documentation

std::vector<HelpText> log_view::HelpPanel::keys_

protected

Definition at line 58 of file help_panel.h.

size_t log_view::HelpPanel::longest_key_ = 0

protected

Definition at line 59 of file help_panel.h.

size_t log_view::HelpPanel::longest_line_ = 0

protected

Definition at line 60 of file help_panel.h.

---

The documentation for this class was generated from the following files:

• help_panel.h
• help_panel.cpp