Selector Class Reference

#include <Selector.hh>

Inheritance diagram for Selector:

Collaboration diagram for Selector:

Public Member Functions
	Selector (Plane *plane, const ncselector_options *opts=nullptr)
	Selector (Plane &plane, const ncselector_options *opts=nullptr)
	~Selector ()
int	additem (const ncselector_item *item) const NOEXCEPT_MAYBE
int	delitem (const char *item) const NOEXCEPT_MAYBE
const char *	previtem () const noexcept
const char *	nextitem () const noexcept
const char *	get_selected () 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 ncselector_options	default_options

Additional Inherited Members
Protected Member Functions inherited from Widget
	Widget (NotCurses *ncinst)
void	ensure_valid_plane (Plane *plane) const
void	ensure_valid_plane (Plane &plane) const
void	take_plane_ownership (Plane *plane) const
void	take_plane_ownership (Plane &plane) const
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 Selector.hh.

Constructor & Destructor Documentation

Selector() [1/2]

Selector ( Plane *  plane, const ncselector_options *  opts = nullptr  )

inlineexplicit

Definition at line 19 of file Selector.hh.

            : Widget (Utilities::get_notcurses_cpp (plane))
        {
            if (plane == nullptr)
                throw invalid_argument ("'plane' must be a valid pointer");
 
            ensure_valid_plane (plane);
            common_init (Utilities::to_ncplane (plane), opts);
            take_plane_ownership (plane);
        }

Selector() [2/2]

Selector ( Plane &  plane, const ncselector_options *  opts = nullptr  )

inlineexplicit

Definition at line 30 of file Selector.hh.

            : Widget (Utilities::get_notcurses_cpp (plane))
        {
            ensure_valid_plane (plane);
            common_init (Utilities::to_ncplane (plane), opts);
            take_plane_ownership (plane);
        }

~Selector()

~Selector ( )

inline

Definition at line 38 of file Selector.hh.

        {
            if (!is_notcurses_stopped ())
                ncselector_destroy (selector, nullptr);
        }

Here is the call graph for this function:

Member Function Documentation

additem()

int additem ( const ncselector_item *  item ) const

inline

Definition at line 44 of file Selector.hh.

        {
            return error_guard<int> (ncselector_additem (selector, item), -1);
        }

Here is the call graph for this function:

delitem()

int delitem ( const char *  item ) const

inline

Definition at line 49 of file Selector.hh.

        {
            return error_guard<int> (ncselector_delitem (selector, item), -1);
        }

Here is the call graph for this function:

get_plane()

Plane * get_plane ( ) const

noexcept

Here is the call graph for this function:

get_selected()

const char * get_selected ( ) const

inlinenoexcept

Definition at line 64 of file Selector.hh.

        {
            return ncselector_selected (selector);
        }

Here is the call graph for this function:

nextitem()

const char * nextitem ( ) const

inlinenoexcept

Definition at line 59 of file Selector.hh.

        {
            return ncselector_nextitem (selector);
        }

Here is the call graph for this function:

offer_input()

bool offer_input ( const struct ncinput *  ni ) const

inlinenoexcept

Definition at line 69 of file Selector.hh.

        {
            return ncselector_offer_input (selector, ni);
        }

Here is the call graph for this function:

previtem()

const char * previtem ( ) const

inlinenoexcept

Definition at line 54 of file Selector.hh.

        {
            return ncselector_previtem (selector);
        }

Here is the call graph for this function:

Field Documentation

default_options

ncselector_options default_options

static

Definition at line 16 of file Selector.hh.

---

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

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