A qualified value representing a display color.
More...
#include <value-types.hh>
Public Attributes |
color | value |
| The display color, if defined.
|
Additional Inherited Members |
bool | always |
| Whether an undefined value should make an entry.
|
static const int | YIELD_COMPARE |
| Indicates that comparison should be based on values, not definedness.
|
Detailed Description
A qualified value representing a display color.
Color values are compared by luminous intensity.
Constructor & Destructor Documentation
Constructs a new defined color.
- Parameters
-
source | The initial definition. |
qualifier | The qualification of the initial value. |
Elemental::ColorValue::ColorValue |
( |
Qualifier |
qualifier = Q_UNK | ) |
throw () |
Constructs a new undefined or default color.
- Parameters
-
qualifier | The qualification of the initial value. |
Elemental::ColorValue::ColorValue |
( |
double |
position, |
|
|
Qualifier |
qualifier = Q_NEUTRAL |
|
) |
| throw () |
|
explicit |
Constructs a new defined color representing a scale position.
- Parameters
-
position | A scale position between 0.0 and 1.0 inclusive. |
qualifier | The qualification of the initial value. |
Member Function Documentation
virtual int Elemental::ColorValue::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
-
other | The 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::ColorValue::do_get_string |
( |
const ustring & |
format | ) |
const throw () |
|
protectedvirtual |
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
-
format | A 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 color Elemental::ColorValue::get_color |
( |
| ) |
const throw () |
|
virtual |
Returns a color representing the value.
Derived classes must implement this function, returning a color that corresponds to the defined value. A special color should be returned if has_value() is false
.
- Returns
- A color structure.
Implements Elemental::color_value_base.
The documentation for this class was generated from the following file: