paludis  Version 2.6.0
Public Member Functions | List of all members
paludis::Choice Class Reference

#include <choice.hh>

Public Member Functions

void add (const std::shared_ptr< const ChoiceValue > &)
 

Basic operations

 Choice (const ChoiceParams &)
 
 ~Choice ()
 

Properties

const std::string raw_name () const PALUDIS_ATTRIBUTE((warn_unused_result))
 
const std::string human_name () const PALUDIS_ATTRIBUTE((warn_unused_result))
 
const ChoicePrefixName prefix () const PALUDIS_ATTRIBUTE((warn_unused_result))
 
bool contains_every_value () const PALUDIS_ATTRIBUTE((warn_unused_result))
 
bool hidden () const PALUDIS_ATTRIBUTE((warn_unused_result))
 
bool hide_description () const PALUDIS_ATTRIBUTE((warn_unused_result))
 
bool show_with_no_prefix () const PALUDIS_ATTRIBUTE((warn_unused_result))
 
bool consider_added_or_changed () const PALUDIS_ATTRIBUTE((warn_unused_result))
 

Iterate over ChoiceValue children

typedef WrappedForwardIterator< ConstIteratorTag, const std::shared_ptr< const ChoiceValue > > ConstIterator
 
ConstIterator begin () const PALUDIS_ATTRIBUTE((warn_unused_result))
 
ConstIterator end () const PALUDIS_ATTRIBUTE((warn_unused_result))
 

Detailed Description

An individual choice in a Choices collection.

Examples of a choice include USE, individual USE_EXPAND values (linguas, video_cards etc) and build_options.

Since
0.32

Constructor & Destructor Documentation

paludis::Choice::Choice ( const ChoiceParams )
Since
0.38

Member Function Documentation

void paludis::Choice::add ( const std::shared_ptr< const ChoiceValue > &  )

Add a new ChoiceValue.

bool paludis::Choice::consider_added_or_changed ( ) const

If false, do not consider flags in this section for 'added' or 'changed' detection.

Used by build_options.

bool paludis::Choice::contains_every_value ( ) const

If true, pretend that we contain every possible value and that any value not listed as a child exists and is not enabled.

For pesky 0-based EAPIs that don't require things like userland_GNU in IUSE, and that don't have a comprehensive list of possible values.

bool paludis::Choice::hidden ( ) const

If true, this option should not usually be shown visually to a user.

bool paludis::Choice::hide_description ( ) const

If true, this option should not have a description be shown visually to the user.

const std::string paludis::Choice::human_name ( ) const

A human-readable name (often the same as raw_name).

const ChoicePrefixName paludis::Choice::prefix ( ) const

The prefix for our ChoiceValue children.

An empty string for USE and ARCH, 'linguas' for LINGUAS etc.

const std::string paludis::Choice::raw_name ( ) const

Our raw name, for example 'USE' or 'LINGUAS'.

bool paludis::Choice::show_with_no_prefix ( ) const

If true, hint that we're better not displaying our prefix to the user.

This is used by –pretend –install and –query to avoid showing a Use: prefix before a list of use flag names.


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