libelemental 2.0.2
Public Member Functions | Static Protected Member Functions | List of all members
Elemental::EntriesView Class Referenceabstract

An interface for the display of value entries. More...

#include <value.hh>

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

Public Member Functions

virtual void header (const ustring &category) throw () =0
 Displays a category header.
 
virtual void entry (const ustring &name, const ustring &value, const ustring &tip=ustring()) throw () =0
 Displays a single value entry.
 

Static Protected Member Functions

static ustring::size_type get_max_name_length () throw ()
 Returns the greatest expected length of an entry name.
 

Detailed Description

An interface for the display of value entries.

Member Function Documentation

◆ entry()

virtual void Elemental::EntriesView::entry ( const ustring &  name,
const ustring &  value,
const ustring &  tip = ustring() 
)
throw (
)
pure 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.

Implemented in Elemental::EntriesStream.

◆ get_max_name_length()

static ustring::size_type Elemental::EntriesView::get_max_name_length ( )
throw (
)
staticprotected

Returns the greatest expected length of an entry name.

This value is calculated from the lengths of translated property names.

◆ header()

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

Displays a category header.

Parameters
categoryThe name of the category.

Implemented in Elemental::EntriesStream.


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