Menu Class Reference

#include <Menu.hh>

Inheritance diagram for Menu:

Collaboration diagram for Menu:

Public Member Functions
	Menu (const ncmenu_options *opts=nullptr, NotCurses *ncinst=nullptr)
	~Menu ()
bool	unroll (int sectionidx) const NOEXCEPT_MAYBE
bool	rollup () const NOEXCEPT_MAYBE
bool	nextsection () const NOEXCEPT_MAYBE
bool	prevsection () const NOEXCEPT_MAYBE
bool	nextitem () const NOEXCEPT_MAYBE
bool	previtem () const NOEXCEPT_MAYBE
bool	item_set_status (const char *section, const char *item, bool status) const NOEXCEPT_MAYBE
const char *	get_selected (ncinput *ni=nullptr) const noexcept
const char *	get_mouse_selected (const struct ncinput *click, struct ncinput *ni) const noexcept
bool	offer_input (const struct ncinput *ni) const noexcept
Plane *	get_plane () const noexcept
Public Member Functions inherited from Root
notcurses *	get_notcurses () const
NotCurses *	get_notcurses_cpp () const

Static Public Attributes
static ncmenu_options	default_options

Additional Inherited Members
Protected Member Functions inherited from Root
	Root (NotCurses *ncinst)
bool	is_notcurses_stopped () const noexcept
Static Protected Member Functions inherited from Root
template<typename TRet = bool, typename TValue = int>
static TRet	error_guard (TValue ret, TValue error_value)
template<typename TRet = bool, typename TValue = int>
static TRet	error_guard_cond (TValue ret, bool error_value)
Static Protected Attributes inherited from Root
static constexpr char	ncpp_invalid_state_message [] = "notcurses++ is in an invalid state (already stopped?)"

Detailed Description

Definition at line 13 of file Menu.hh.

Constructor & Destructor Documentation

Menu()

Menu ( const ncmenu_options *  opts = nullptr, NotCurses *  ncinst = nullptr  )

inlineexplicit

Definition at line 19 of file Menu.hh.

            : Root (ncinst)
        {
            menu = ncmenu_create (notcurses_stdplane (get_notcurses ()), opts == nullptr ? &default_options : opts);
            if (menu == nullptr)
                throw init_error ("Notcurses failed to create a new menu");
        }

Here is the call graph for this function:

~Menu()

~Menu ( )

inline

Definition at line 27 of file Menu.hh.

        {
            if (!is_notcurses_stopped ())
                ncmenu_destroy (menu);
        }

Here is the call graph for this function:

Member Function Documentation

get_mouse_selected()

const char * get_mouse_selected ( const struct ncinput *  click, struct ncinput *  ni  ) const

inlinenoexcept

Definition at line 73 of file Menu.hh.

        {
            return ncmenu_mouse_selected (menu, click, ni);
        }

Here is the call graph for this function:

get_plane()

Plane * get_plane ( ) const

noexcept

get_selected()

const char * get_selected ( ncinput *  ni = nullptr ) const

inlinenoexcept

Definition at line 68 of file Menu.hh.

        {
            return ncmenu_selected (menu, ni);
        }

Here is the call graph for this function:

item_set_status()

bool item_set_status ( const char *  section, const char *  item, bool  status  ) const

inline

Definition at line 63 of file Menu.hh.

        {
            return error_guard (ncmenu_item_set_status (menu, section, item, status), -1);
        }

Here is the call graph for this function:

nextitem()

bool nextitem ( ) const

inline

Definition at line 53 of file Menu.hh.

        {
            return error_guard (ncmenu_nextitem (menu), -1);
        }

Here is the call graph for this function:

nextsection()

bool nextsection ( ) const

inline

Definition at line 43 of file Menu.hh.

        {
            return error_guard (ncmenu_nextsection (menu), -1);
        }

Here is the call graph for this function:

offer_input()

bool offer_input ( const struct ncinput *  ni ) const

inlinenoexcept

Definition at line 78 of file Menu.hh.

        {
            return ncmenu_offer_input (menu, ni);
        }

Here is the call graph for this function:

previtem()

bool previtem ( ) const

inline

Definition at line 58 of file Menu.hh.

        {
            return error_guard (ncmenu_previtem (menu), -1);
        }

Here is the call graph for this function:

prevsection()

bool prevsection ( ) const

inline

Definition at line 48 of file Menu.hh.

        {
            return error_guard (ncmenu_prevsection (menu), -1);
        }

Here is the call graph for this function:

rollup()

bool rollup ( ) const

inline

Definition at line 38 of file Menu.hh.

        {
            return error_guard (ncmenu_rollup (menu), -1);
        }

Here is the call graph for this function:

unroll()

bool unroll ( int  sectionidx ) const

inline

Definition at line 33 of file Menu.hh.

        {
            return error_guard (ncmenu_unroll (menu, sectionidx), -1);
        }

Here is the call graph for this function:

Field Documentation

default_options

ncmenu_options default_options

static

Definition at line 16 of file Menu.hh.

---

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

• /home/dank/src/dankamongmen/notcurses/include/ncpp/Menu.hh