libelemental 1.2.0
Public Member Functions | Public Attributes | Protected Member Functions

Elemental::Message Class Reference

A qualified UTF-8 string value that requires translation. More...

#include <value-types.hh>

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

List of all members.

Public Member Functions

 Message (const char *source, Qualifier qualifier=Q_NEUTRAL) throw ()
 Constructs a new defined message.
 Message (Qualifier qualifier=Q_UNK) throw ()
 Constructs a new undefined or empty message.
virtual int compare (const value_base &other) const throw ()
 Compares two qualified values.
virtual ustring get_string (const ustring &format=ustring()) const throw ()
 Returns a localized text representation of the value.

Public Attributes

ustring value
 The untranslated message, if defined.

Protected Member Functions

virtual ustring do_get_string (const ustring &format) const throw ()
 Returns a localized text representation of a defined value.

Detailed Description

A qualified UTF-8 string value that requires translation.

Messages are compared by collation order.


Constructor & Destructor Documentation

Elemental::Message::Message ( const char *  source,
Qualifier  qualifier = Q_NEUTRAL 
) throw ()

Constructs a new defined message.

Parameters:
sourceThe untranslated message.
qualifierThe qualification of the message.
Elemental::Message::Message ( Qualifier  qualifier = Q_UNK) throw ()

Constructs a new undefined or empty message.

Parameters:
qualifierThe qualification of the message.

Member Function Documentation

virtual int Elemental::Message::compare ( const value_base other) const throw () [virtual]

Compares two qualified values.

Derived classes may override this function, first calling compare_base, and use a dynamic_cast to check other.

Parameters:
otherThe qualified value for comparison.
Returns:
-1 if this value is undefined or is less than other; 0 if the values are equal; or 1 if other is undefined or this value is greater than other.

Reimplemented from Elemental::value_base.

virtual ustring Elemental::Message::do_get_string ( const ustring &  format) const throw () [protected, virtual]

Returns a localized text representation of a defined value.

Derived classes must implement this function to produce a text representation based on the format. It will be called by get_string(), which will then decorate its output as appropriate for the current qualifier. If has_value() is false, the behavior is undefined.

Parameters:
formatA compose-style format string. Derived classes may define the number of argument references expected in the string; the default is one. If format is empty, a minimal default should be used.
Returns:
A UTF-8 string containing the localized representation.

Implements Elemental::value_base.

virtual ustring Elemental::Message::get_string ( const ustring &  format = ustring()) const throw () [virtual]

Returns a localized text representation of the value.

Parameters:
formatAn optional compose-style format string with which to output the value. If not otherwise specified, the value is argument reference %1.
Returns:
A UTF-8 string containing the localized representation.

Reimplemented from Elemental::value_base.


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