paludis::ChoiceValue Class Reference
[Choices]

#include <choice.hh>

Inherited by paludis::ELikeExpensiveTestsChoiceValue, paludis::ELikeJobsChoiceValue, paludis::ELikeOptionalTestsChoiceValue, paludis::ELikeRecommendedTestsChoiceValue, paludis::ELikeSplitChoiceValue, paludis::ELikeStripChoiceValue, and paludis::ELikeTraceChoiceValue.

List of all members.

Basic operations

virtual ~ChoiceValue ()=0

Properties

virtual const UnprefixedChoiceName unprefixed_name () const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual const ChoiceNameWithPrefix name_with_prefix () const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual bool enabled () const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual bool enabled_by_default () const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual bool locked () const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual const std::string description () const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual bool explicitly_listed () const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual const std::string parameter () const PALUDIS_ATTRIBUTE((warn_unused_result))=0


Detailed Description

An individial Value in a ChoiceValue.

For example, the 'nls' flag in 'USE'.

Some choice values have an associated parameter. For example, build_options:jobs=4.

Since:
0.32

Member Function Documentation

virtual const UnprefixedChoiceName paludis::ChoiceValue::unprefixed_name (  )  const [pure virtual]

Our name, without an prefix (for example, 'nls' or 'en').

virtual const ChoiceNameWithPrefix paludis::ChoiceValue::name_with_prefix (  )  const [pure virtual]

Our name, with prefix if there is one (for example, 'nls' or 'linguas_en').

virtual bool paludis::ChoiceValue::enabled (  )  const [pure virtual]

Is this flag enabled?

virtual bool paludis::ChoiceValue::enabled_by_default (  )  const [pure virtual]

Would this flag be enabled by default (i.e. before considering any overrides from the Environment)?

virtual bool paludis::ChoiceValue::locked (  )  const [pure virtual]

Is this flag locked (forced or masked)?

virtual const std::string paludis::ChoiceValue::description (  )  const [pure virtual]

The flag's description, or an empty string.

virtual bool paludis::ChoiceValue::explicitly_listed (  )  const [pure virtual]

Is this flag explicitly listed?

Use this to avoid showing things like LINGUAS values that aren't listed in IUSE but that end up as a ChoiceValue anyway.

virtual const std::string paludis::ChoiceValue::parameter (  )  const [pure virtual]

This flag's parameter, or an empty string if it doesn't have one.

Since:
0.40


The documentation for this class was generated from the following file:
Generated on Mon Sep 21 10:36:09 2009 for paludis by  doxygen 1.5.4