Progbar Class Reference

#include <Progbar.hh>

Inheritance diagram for Progbar:

Collaboration diagram for Progbar:

Public Member Functions
	Progbar (Plane &n, const ncprogbar_options *opts)
	~Progbar ()
Plane *	get_plane () const noexcept
void	set_progress (double p) const noexcept
double	get_progress () 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 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 Progbar.hh.

Constructor & Destructor Documentation

Progbar()

Progbar ( Plane &  n, const ncprogbar_options *  opts  )

inline

Definition at line 15 of file Progbar.hh.

            : Root (nullptr)
        {
            if (opts == nullptr) {
                throw invalid_argument ("Argument 'opts' must be a valid pointer");
            }
 
            progbar = ncprogbar_create (n, opts);
            if (progbar == nullptr) {
                throw init_error ("Notcurses failed to create ncprogbar");
            }
        }

Here is the call graph for this function:

~Progbar()

~Progbar ( )

inline

Definition at line 28 of file Progbar.hh.

        {
            if (!is_notcurses_stopped ()) {
                ncprogbar_destroy (progbar);
            }
        }

Here is the call graph for this function:

Member Function Documentation

get_plane()

Plane * get_plane ( ) const

inlinenoexcept

Definition at line 35 of file Progbar.hh.

        {
            ncplane *ret = ncprogbar_plane (progbar);
            if (ret == nullptr) {
                return nullptr;
            }
 
            return Plane::map_plane (ret);
        }

Here is the call graph for this function:

get_progress()

double get_progress ( ) const

inlinenoexcept

Definition at line 50 of file Progbar.hh.

        {
            return ncprogbar_progress (progbar);
        }

Here is the call graph for this function:

set_progress()

void set_progress ( double  p ) const

inlinenoexcept

Definition at line 45 of file Progbar.hh.

        {
            ncprogbar_set_progress (progbar, p);
        }

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/Progbar.hh