Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::formatter_factory< CharT > Struct Template Referenceabstract

Formatter factory base interface. More...

#include <formatter_parser.hpp>

Inheritance diagram for boost::formatter_factory< CharT >:

Public Types

typedef CharT char_type
 Character type. More...
 
typedef std::basic_string
< char_type
string_type
 String type. More...
 
typedef basic_formatter
< char_type
formatter_type
 The formatter function object. More...
 
typedef std::map< string_type,
string_type
args_map
 Type of the map of formatter factory arguments [argument name -> argument value]. More...
 

Public Member Functions

virtual ~formatter_factory ()
 Default constructor. More...
 
virtual formatter_type create_formatter (attribute_name const &name, args_map const &args)=0
 The function creates a formatter for the specified attribute. More...
 

Detailed Description

template<typename CharT>
struct boost::formatter_factory< CharT >

Formatter factory base interface.

Member Typedef Documentation

template<typename CharT >
typedef std::map< string_type, string_type > boost::formatter_factory< CharT >::args_map

Type of the map of formatter factory arguments [argument name -> argument value].

This type of maps will be passed to formatter factories on attempt to create a formatter.

template<typename CharT >
typedef CharT boost::formatter_factory< CharT >::char_type

Character type.

template<typename CharT >
typedef basic_formatter< char_type > boost::formatter_factory< CharT >::formatter_type

The formatter function object.

template<typename CharT >
typedef std::basic_string< char_type > boost::formatter_factory< CharT >::string_type

String type.

Constructor & Destructor Documentation

template<typename CharT >
virtual boost::formatter_factory< CharT >::~formatter_factory ( )
inlinevirtual

Default constructor.

Virtual destructor

Member Function Documentation

template<typename CharT >
virtual formatter_type boost::formatter_factory< CharT >::create_formatter ( attribute_name const &  name,
args_map const &  args 
)
pure virtual

The function creates a formatter for the specified attribute.

Parameters
nameAttribute name
argsFormatter arguments

Implemented in boost::basic_formatter_factory< CharT, AttributeValueT >.


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