senf::console::ParsedCommandAttributorBase Class Reference
Generic ParsedCommandOverloadBase attributes. More...#include <senf/Utils/Console/ParsedCommand.hh>
Detailed Description
Generic ParsedCommandOverloadBase attributes.Attributes for parsed commands are not set directly on the node. They are set via a special attributor temporary returned when adding a parsed command to the tree.
This class is the base class for those attributors. It provides members which do not depend in any way on the exact type of command added.
- See also:
- Automatic argument parsing
Definition at line 202 of file ParsedCommand.hh.
Public Types |
|
| typedef OverloadedCommandNode | node_type |
| typedef OverloadedCommandNode & | result_type |
Protected Member Functions |
|
| ParsedCommandAttributorBase (ParsedCommandOverloadBase::ptr overload, unsigned index) | |
| ParsedCommandAttributorBase (ParsedCommandAttributorBase const &other, unsigned index) | |
| void | argName (std::string const &name) |
| void | argDoc (std::string const &doc) |
| void | typeName (std::string const &doc) |
| void | defaultDoc (std::string const &doc) |
| ParsedCommandOverloadBase & | overload () const |
| void | overloadDoc (std::string const &doc) |
| void | nodeDoc (std::string const &doc) |
| void | shortDoc (std::string const &doc) |
Member Typedef Documentation
| typedef OverloadedCommandNode senf::console::ParsedCommandAttributorBase:: | ||||
| node_type | ||||
Reimplemented in senf::console::factory::Command.
Definition at line 206 of file ParsedCommand.hh.
| typedef OverloadedCommandNode& senf::console::ParsedCommandAttributorBase:: | ||||
| result_type | ||||
Reimplemented in senf::console::factory::Command.
Definition at line 207 of file ParsedCommand.hh.
Constructor & Destructor Documentation
| senf::console::ParsedCommandAttributorBase:: | ||||
| ParsedCommandAttributorBase | ( | ParsedCommandOverloadBase::ptr | overload, | |
| unsigned | index | ) | ||
Definition at line 75 of file ParsedCommand.cci.
| senf::console::ParsedCommandAttributorBase:: | ||||
| ParsedCommandAttributorBase | ( | ParsedCommandAttributorBase const & | other, | |
| unsigned | index | ) | ||
Definition at line 80 of file ParsedCommand.cci.
Member Function Documentation
| void senf::console::ParsedCommandAttributorBase:: | ||||
| argDoc | ( | std::string const & | doc | ) |
Definition at line 96 of file ParsedCommand.cci.
| void senf::console::ParsedCommandAttributorBase:: | ||||
| argName | ( | std::string const & | name | ) |
Definition at line 91 of file ParsedCommand.cci.
| void senf::console::ParsedCommandAttributorBase:: | ||||
| defaultDoc | ( | std::string const & | doc | ) |
Definition at line 106 of file ParsedCommand.cci.
| void senf::console::ParsedCommandAttributorBase:: | ||||
| nodeDoc | ( | std::string const & | doc | ) |
Definition at line 116 of file ParsedCommand.cci.
| senf::console::ParsedCommandOverloadBase & senf::console::ParsedCommandAttributorBase:: | ||||
| overload | () | |||
Reimplemented in senf::console::ParsedCommandAttributor< Overload >, and senf::console::ParsedCommandAttributor< Overload >.
Definition at line 85 of file ParsedCommand.cci.
| void senf::console::ParsedCommandAttributorBase:: | ||||
| overloadDoc | ( | std::string const & | doc | ) |
Reimplemented in senf::console::ParsedArgumentAttributorBase< Overload, Self, ReturnType >, and senf::console::ParsedArgumentAttributorBase< Overload, ParsedArgumentAttributor< Overload, index, flag > >.
Definition at line 111 of file ParsedCommand.cci.
| void senf::console::ParsedCommandAttributorBase:: | ||||
| shortDoc | ( | std::string const & | doc | ) |
Definition at line 121 of file ParsedCommand.cci.
| void senf::console::ParsedCommandAttributorBase:: | ||||
| typeName | ( | std::string const & | doc | ) |
Definition at line 101 of file ParsedCommand.cci.
The documentation for this class was generated from the following files: