libelemental 2.0.2
Public Member Functions | List of all members
Elemental::EntriesStream Class Reference

An adapter for the display of value entries on an output stream. More...

#include <value.hh>

Inheritance diagram for Elemental::EntriesStream:
Inheritance graph
[legend]

Public Member Functions

 EntriesStream (FILE *file) throw ()
 Constructs a new EntriesStream for an open FILE pointer.
 
 EntriesStream (int fd) throw ()
 Constructs a new EntriesStream for an open file descriptor.
 
 EntriesStream (std::streambuf &buf) throw ()
 Constructs a new EntriesStream for a stream buffer.
 
 EntriesStream (std::ostream &os) throw ()
 Constructs a new EntriesStream for an output stream.
 
virtual void header (const ustring &category) throw ()
 Displays a category header.
 
virtual void entry (const ustring &name, const ustring &value, const ustring &tip=ustring()) throw ()
 Displays a single value entry.
 

Additional Inherited Members

- Static Protected Member Functions inherited from Elemental::EntriesView
static ustring::size_type get_max_name_length () throw ()
 Returns the greatest expected length of an entry name.
 

Detailed Description

An adapter for the display of value entries on an output stream.

Member Function Documentation

◆ entry()

virtual void Elemental::EntriesStream::entry ( const ustring &  name,
const ustring &  value,
const ustring &  tip = ustring() 
)
throw (
)
virtual

Displays a single value entry.

Parameters
nameThe name of the entry.
valueA localized string representation of the value of the entry.
tipQualifying information, if any, to be displayed as a tip.

Implements Elemental::EntriesView.

◆ header()

virtual void Elemental::EntriesStream::header ( const ustring &  category)
throw (
)
virtual

Displays a category header.

Parameters
categoryThe name of the category.

Implements Elemental::EntriesView.


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