NcReel Class Reference

#include <Reel.hh>

Inheritance diagram for NcReel:

Collaboration diagram for NcReel:

Public Member Functions
	NcReel (Plane &plane, const ncreel_options *popts=nullptr)
	NcReel (Plane *plane, const ncreel_options *popts=nullptr)
	~NcReel ()
	operator ncreel * () const noexcept
	operator ncreel const * () const noexcept
NcTablet *	add (NcTablet *after, NcTablet *before, tabletcb cb, void *opaque=nullptr) const
NcTablet *	add (NcTablet &after, NcTablet &before, tabletcb cb, void *opaque=nullptr) const noexcept
int	get_tabletcount () const noexcept
bool	del (NcTablet *t) const NOEXCEPT_MAYBE
bool	del (NcTablet &t) const NOEXCEPT_MAYBE
bool	redraw () const NOEXCEPT_MAYBE
NcTablet *	get_focused () const noexcept
NcTablet *	next () const noexcept
NcTablet *	prev () const noexcept
bool	offer_input (const struct ncinput *nci) const NOEXCEPT_MAYBE
Plane *	get_plane () const noexcept
Public Member Functions inherited from Root
notcurses *	get_notcurses () const
NotCurses *	get_notcurses_cpp () const

Static Public Attributes
static ncreel_options	default_options

Friends
class	Plane

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 14 of file Reel.hh.

Constructor & Destructor Documentation

NcReel() [1/2]

NcReel ( Plane &  plane, const ncreel_options *  popts = nullptr  )

inlineexplicit

Definition at line 19 of file Reel.hh.

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

NcReel() [2/2]

NcReel ( Plane *  plane, const ncreel_options *  popts = nullptr  )

inlineexplicit

Definition at line 27 of file Reel.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), popts);
            take_plane_ownership (plane);
        }

~NcReel()

~NcReel ( )

inline

Definition at line 38 of file Reel.hh.

        {
            if (!is_notcurses_stopped ())
                ncreel_destroy (reel);
        }

Here is the call graph for this function:

Member Function Documentation

add() [1/2]

NcTablet * add ( NcTablet &  after, NcTablet &  before, tabletcb  cb, void *  opaque = nullptr  ) const

inlinenoexcept

Definition at line 64 of file Reel.hh.

        {
            return add (&after, &before, cb, opaque);
        }

add() [2/2]

NcTablet * add ( NcTablet *  after, NcTablet *  before, tabletcb  cb, void *  opaque = nullptr  ) const

inline

Definition at line 55 of file Reel.hh.

        {
            nctablet *t = ncreel_add (reel, get_tablet (after), get_tablet (before), cb, opaque);
            if (t == nullptr)
                throw init_error ("Notcurses failed to create a new tablet");
 
            return NcTablet::map_tablet (t, get_notcurses_cpp ());
        }

Here is the call graph for this function:

del() [1/2]

bool del ( NcTablet &  t ) const

inline

Definition at line 79 of file Reel.hh.

        {
            return del (&t);
        }

del() [2/2]

bool del ( NcTablet *  t ) const

inline

Definition at line 74 of file Reel.hh.

        {
            return error_guard (ncreel_del (reel, get_tablet (t)), -1);
        }

Here is the call graph for this function:

get_focused()

NcTablet * get_focused ( ) const

inlinenoexcept

Definition at line 89 of file Reel.hh.

        {
            nctablet *t = ncreel_focused (reel);
            if (t == nullptr)
                return nullptr;
 
            return NcTablet::map_tablet (t, get_notcurses_cpp ());
        }

Here is the call graph for this function:

get_plane()

Plane * get_plane ( ) const

noexcept

get_tabletcount()

int get_tabletcount ( ) const

inlinenoexcept

Definition at line 69 of file Reel.hh.

        {
            return ncreel_tabletcount (reel);
        }

Here is the call graph for this function:

next()

NcTablet * next ( ) const

inlinenoexcept

Definition at line 98 of file Reel.hh.

        {
            nctablet *t = ncreel_next (reel);
            if (t == nullptr)
                return nullptr;
 
            return NcTablet::map_tablet (t, get_notcurses_cpp ());
        }

Here is the call graph for this function:

offer_input()

bool offer_input ( const struct ncinput *  nci ) const

inline

Definition at line 116 of file Reel.hh.

        {
            return error_guard<bool, bool> (ncreel_offer_input (reel, nci), false);
        }

Here is the call graph for this function:

operator ncreel *()

operator ncreel * ( ) const

inlinenoexcept

Definition at line 44 of file Reel.hh.

        {
            return reel;
        }

operator ncreel const *()

operator ncreel const * ( ) const

inlinenoexcept

Definition at line 49 of file Reel.hh.

        {
            return reel;
        }

prev()

NcTablet * prev ( ) const

inlinenoexcept

Definition at line 107 of file Reel.hh.

        {
            nctablet *t = ncreel_prev (reel);
            if (t == nullptr)
                return nullptr;
 
            return NcTablet::map_tablet (t, get_notcurses_cpp ());
        }

Here is the call graph for this function:

redraw()

bool redraw ( ) const

inline

Definition at line 84 of file Reel.hh.

        {
            return error_guard (ncreel_redraw (reel), -1);
        }

Here is the call graph for this function:

Friends And Related Symbol Documentation

Plane

friend class Plane

friend

Definition at line 142 of file Reel.hh.

Field Documentation

default_options

ncreel_options default_options

static

Definition at line 17 of file Reel.hh.

---

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

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