Args::HelpPrinterIface Class Reference

Interface for HelpPrinter. More...

#include <help_printer_iface.hpp>

Inheritance diagram for Args::HelpPrinterIface:

Public Member Functions
	HelpPrinterIface ()
virtual	~HelpPrinterIface ()
virtual void	print (OutStreamType &to)=0
	Print help for all arguments.
virtual void	print (const String &name, OutStreamType &to, Command *parent=nullptr)=0
	Print help for the given argument.
virtual void	setExecutable (const String &exe)=0
	Set executable name.
virtual void	setAppDescription (const String &desc)=0
	Set description for the application.
virtual void	setCmdLine (CmdLine *cmd)=0
	Set command line.
virtual void	setLineLength (String::size_type length)=0
	Set line length for the help.
virtual ArgIface *	findArgument (const String &name)=0

Detailed Description

Interface for HelpPrinter.

Definition at line 27 of file help_printer_iface.hpp.

Constructor & Destructor Documentation

HelpPrinterIface()

Args::HelpPrinterIface::HelpPrinterIface ( )

inline

Definition at line 30 of file help_printer_iface.hpp.

~HelpPrinterIface()

virtual Args::HelpPrinterIface::~HelpPrinterIface ( )

inlinevirtual

Definition at line 34 of file help_printer_iface.hpp.

Member Function Documentation

findArgument()

virtual ArgIface * Args::HelpPrinterIface::findArgument ( const String & name )

pure virtual

Returns

Argument for the given name.

Implemented in Args::HelpPrinter.

print() [1/2]

virtual void Args::HelpPrinterIface::print ( const String & name, OutStreamType & to, Command * parent = nullptr )

pure virtual

Print help for the given argument.

Parameters

name	Name of the argument. I.e. "-t" or "--timeout".
to	Output stream for the printing help.
parent	Parent command if present.

Implemented in Args::HelpPrinter.

print() [2/2]

virtual void Args::HelpPrinterIface::print ( OutStreamType & to )

pure virtual

Print help for all arguments.

Parameters

to	Output stream for the printing help.

Implemented in Args::HelpPrinter.

setAppDescription()

virtual void Args::HelpPrinterIface::setAppDescription ( const String & desc )

pure virtual

Set description for the application.

Implemented in Args::HelpPrinter.

setCmdLine()

virtual void Args::HelpPrinterIface::setCmdLine ( CmdLine * cmd )

pure virtual

Set command line.

Implemented in Args::HelpPrinter.

setExecutable()

virtual void Args::HelpPrinterIface::setExecutable ( const String & exe )

pure virtual

Set executable name.

Implemented in Args::HelpPrinter.

setLineLength()

virtual void Args::HelpPrinterIface::setLineLength ( String::size_type length )

pure virtual

Set line length for the help.

Implemented in Args::HelpPrinter.

---

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

• help_printer_iface.hpp