ILeafBase Struct Reference
Base class of all leaves. More...
#include "IOption.hpp"
Inheritance diagram for ILeafBase:
Public Member Functions | |
| virtual UsageLevel::Type | usageLevel () const =0 |
| Frequency / expected skills of users that access this leaf. | |
| virtual ValueSource::Type | valueSource () const =0 |
| The context in which the value has been set. | |
| virtual bool | empty () const =0 |
| If its value has not been set, a leaf is considered empty. | |
| Public Member Functions inherited from IBase | |
| virtual Names::Type | enumerator () const =0 |
| The option name as enumerator. | |
| virtual String | name () const =0 |
| The option name as string. | |
| virtual String | path () const =0 |
| The option name as string, preceded by the names of its parents, if any, interspersed with '.'. | |
| virtual String | shortDescription () const =0 |
| One-liner that describes this option. | |
| virtual String | longDescription () const =0 |
| Longer text that describes this option in more detail. | |
| virtual bool | readOnly () const =0 |
| Returns true if this or any of its parents is read-only. | |
| virtual UsageLevel::Type | minUsageLevel () const =0 |
| For a leaf, this is its own usage level. For a node, this is the minimum usage level of all of its descendants: basic < mid < pro. | |
| virtual Specs::Type | specialization () const =0 |
| The sub-type of this option. | |
Detailed Description
Base class of all leaves.
Member Function Documentation
|
pure virtual |
If its value has not been set, a leaf is considered empty.
Accessing its value then raises an exception.
