• Overview
  • Examples
  • HowTos
  • Glossary
    • Public Types | Protected Member Functions | List of all members
    senf::console::ParsedCommandAttributorBase Class Reference

    Generic ParsedCommandOverloadBase attributes. More...

    #include <senf/Utils/Console/ParsedCommand.hh>

    Inheritance diagram for senf::console::ParsedCommandAttributorBase:
    Inheritance graph
    [legend]

    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)
     

    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 192 of file ParsedCommand.hh.

    Member Typedef Documentation

    ◆ node_type

    typedef OverloadedCommandNode senf::console::ParsedCommandAttributorBase::node_type

    Definition at line 196 of file ParsedCommand.hh.

    ◆ result_type

    typedef OverloadedCommandNode& senf::console::ParsedCommandAttributorBase::result_type

    Definition at line 197 of file ParsedCommand.hh.

    Constructor & Destructor Documentation

    ◆ ParsedCommandAttributorBase() [1/2]

    senf::console::ParsedCommandAttributorBase::ParsedCommandAttributorBase ( ParsedCommandOverloadBase::ptr  overload,
    unsigned  index 
    )
    		protected

    ◆ ParsedCommandAttributorBase() [2/2]

    senf::console::ParsedCommandAttributorBase::ParsedCommandAttributorBase ( ParsedCommandAttributorBase const &  other,
    unsigned  index 
    )
    		protected

    Member Function Documentation

    ◆ argDoc()

    void senf::console::ParsedCommandAttributorBase::argDoc ( std::string const &  doc)
    		protected

    ◆ argName()

    void senf::console::ParsedCommandAttributorBase::argName ( std::string const &  name)
    		protected

    ◆ defaultDoc()

    void senf::console::ParsedCommandAttributorBase::defaultDoc ( std::string const &  doc)
    		protected

    ◆ nodeDoc()

    void senf::console::ParsedCommandAttributorBase::nodeDoc ( std::string const &  doc)
    		protected

    ◆ overload()

    ParsedCommandOverloadBase& senf::console::ParsedCommandAttributorBase::overload ( ) const
    		protected

    ◆ overloadDoc()

    void senf::console::ParsedCommandAttributorBase::overloadDoc ( std::string const &  doc)
    		protected

    ◆ shortDoc()

    void senf::console::ParsedCommandAttributorBase::shortDoc ( std::string const &  doc)
    		protected

    ◆ typeName()

    void senf::console::ParsedCommandAttributorBase::typeName ( std::string const &  doc)
    		protected
    The documentation for this class was generated from the following file: