Reader Class Reference

#include <Reader.hh>

Inheritance diagram for Reader:

Collaboration diagram for Reader:

Public Member Functions
	Reader (Plane *plane, const ncreader_options *opts)
	Reader (Plane &plane, const ncreader_options *opts)
	~Reader ()
bool	clear () const NOEXCEPT_MAYBE
int	move_left () const noexcept
int	move_right () const noexcept
int	move_up () const noexcept
int	move_down () const noexcept
bool	write_egc (const char *egc) const NOEXCEPT_MAYBE
char *	get_contents () const noexcept
Plane *	get_plane () const noexcept
Public Member Functions inherited from Root
notcurses *	get_notcurses () const
NotCurses *	get_notcurses_cpp () const

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 Reader.hh.

Constructor & Destructor Documentation

Reader() [1/2]

Reader ( Plane *  plane, const ncreader_options *  opts  )

inlineexplicit

Definition at line 16 of file Reader.hh.

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

Reader() [2/2]

Reader ( Plane &  plane, const ncreader_options *  opts  )

inlineexplicit

Definition at line 24 of file Reader.hh.

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

~Reader()

~Reader ( )

inline

Definition at line 32 of file Reader.hh.

        {
            if (!is_notcurses_stopped ())
                ncreader_destroy (reader, nullptr);
        }

Here is the call graph for this function:

Member Function Documentation

clear()

bool clear ( ) const

inline

Definition at line 38 of file Reader.hh.

        {
            bool ret = ncreader_clear (reader) != 0;
            return error_guard_cond<bool, bool> (ret, ret);
        }

Here is the call graph for this function:

get_contents()

char * get_contents ( ) const

inlinenoexcept

Definition at line 74 of file Reader.hh.

        {
            return ncreader_contents(reader);
        }

Here is the call graph for this function:

get_plane()

Plane * get_plane ( ) const

inlinenoexcept

Definition at line 79 of file Reader.hh.

        {
            return Plane::map_plane (ncreader_plane (reader));
        }

Here is the call graph for this function:

move_down()

int move_down ( ) const

inlinenoexcept

Definition at line 64 of file Reader.hh.

        {
            return ncreader_move_down (reader);
        }

Here is the call graph for this function:

move_left()

int move_left ( ) const

inlinenoexcept

Definition at line 49 of file Reader.hh.

        {
            return ncreader_move_left (reader);
        }

Here is the call graph for this function:

move_right()

int move_right ( ) const

inlinenoexcept

Definition at line 54 of file Reader.hh.

        {
            return ncreader_move_right (reader);
        }

Here is the call graph for this function:

move_up()

int move_up ( ) const

inlinenoexcept

Definition at line 59 of file Reader.hh.

        {
            return ncreader_move_up (reader);
        }

Here is the call graph for this function:

write_egc()

bool write_egc ( const char *  egc ) const

inline

Definition at line 69 of file Reader.hh.

        {
            return error_guard (ncreader_write_egc (reader, egc), -1);
        }

Here is the call graph for this function:

---

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

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