FDPlane Class Reference

#include <FDPlane.hh>

Inheritance diagram for FDPlane:

Collaboration diagram for FDPlane:

Public Member Functions
	FDPlane (Plane *plane, int fd, ncfdplane_callback cbfxn=nullptr, ncfdplane_done_cb donecbfxn=nullptr)
	FDPlane (Plane *plane, int fd, ncfdplane_options *opts=nullptr, ncfdplane_callback cbfxn=nullptr, ncfdplane_done_cb donecbfxn=nullptr)
	FDPlane (Plane &plane, int fd, ncfdplane_callback cbfxn=nullptr, ncfdplane_done_cb donecbfxn=nullptr)
	FDPlane (Plane &plane, int fd, ncfdplane_options *opts=nullptr, ncfdplane_callback cbfxn=nullptr, ncfdplane_done_cb donecbfxn=nullptr)
	~FDPlane ()
Plane *	get_plane () const noexcept
Public Member Functions inherited from Root
notcurses *	get_notcurses () const
NotCurses *	get_notcurses_cpp () const

Static Public Attributes
static ncfdplane_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 12 of file FDPlane.hh.

Constructor & Destructor Documentation

FDPlane() [1/4]

FDPlane ( Plane *  plane, int  fd, ncfdplane_callback  cbfxn = nullptr, ncfdplane_done_cb  donecbfxn = nullptr  )

inlineexplicit

Definition at line 18 of file FDPlane.hh.

            : FDPlane (plane, fd, nullptr, cbfxn, donecbfxn)
        {}

FDPlane() [2/4]

FDPlane ( Plane *  plane, int  fd, ncfdplane_options *  opts = nullptr, ncfdplane_callback  cbfxn = nullptr, ncfdplane_done_cb  donecbfxn = nullptr  )

inlineexplicit

Definition at line 22 of file FDPlane.hh.

            : Widget (Utilities::get_notcurses_cpp (plane))
        {
            ensure_valid_plane (plane);
            create_fdplane (*plane, fd, opts, cbfxn, donecbfxn);
            take_plane_ownership (plane);
        }

FDPlane() [3/4]

FDPlane ( Plane &  plane, int  fd, ncfdplane_callback  cbfxn = nullptr, ncfdplane_done_cb  donecbfxn = nullptr  )

inlineexplicit

Definition at line 30 of file FDPlane.hh.

            : FDPlane (plane, fd, nullptr, cbfxn, donecbfxn)
        {}

FDPlane() [4/4]

FDPlane ( Plane &  plane, int  fd, ncfdplane_options *  opts = nullptr, ncfdplane_callback  cbfxn = nullptr, ncfdplane_done_cb  donecbfxn = nullptr  )

inlineexplicit

Definition at line 34 of file FDPlane.hh.

            : Widget (Utilities::get_notcurses_cpp (plane))
        {
            ensure_valid_plane (plane);
            create_fdplane (plane, fd, opts, cbfxn, donecbfxn);
            take_plane_ownership (plane);
        }

~FDPlane()

~FDPlane ( )

inline

Definition at line 42 of file FDPlane.hh.

        {
            if (is_notcurses_stopped ())
                return;
 
            ncfdplane_destroy (fdplane);
        }

Here is the call graph for this function:

Member Function Documentation

get_plane()

Plane * get_plane ( ) const

inlinenoexcept

Definition at line 50 of file FDPlane.hh.

        {
            return Plane::map_plane (ncfdplane_plane (fdplane));
        }

Here is the call graph for this function:

Field Documentation

default_options

ncfdplane_options default_options

static

Definition at line 15 of file FDPlane.hh.

---

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

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