Option Class Reference

#include <settings.hpp>

Collaboration diagram for Option:

Classes
class	Callback

Public Types
enum	OptType { StringOpt , BoolOpt , SilentOpt }

Public Member Functions
	Option (Settings *settings, const std::string &name="", OptType type=OptType::StringOpt, const std::string &param="", const std::string &defaultValue="", bool enabled=true)
virtual	~Option ()
void	addOnChangeCallback (Callback callback)
void	addSuboption (Option *sub, const std::string &limit="")
void	changed ()
virtual std::string	getLaunchOption () const
std::string	getName () const
std::string	getParam () const
Settings *	getSettings ()
std::string	getSubVals () const
OptType	getType () const
std::string	getValue () const
bool	isEnabled () const
void	removeOnChangeCallback (const Callback &callback)
virtual void	setDefaultValue (const std::string &val)
void	setEnabled (bool enable, bool suppressCallback=false)
void	setParam (const std::string &p)
void	setType (OptType type)
virtual void	setValue (const std::string &val, bool suppressCallback=false)

Static Protected Member Functions
static void	suboptionChanged (Option &opt, bool suboption, void *opaque)

Protected Attributes
std::string	defaultValue
bool	enabled
std::string	name
std::vector< Callback >	onChangeCallbacks
std::string	param
Settings *	settings
std::vector< std::pair< std::string, Option * > >	suboptions
OptType	type
std::string	value

Detailed Description

Definition at line 12 of file settings.hpp.

Member Enumeration Documentation

OptType

enum Option::OptType

Enumerator
StringOpt
BoolOpt
SilentOpt

Definition at line 28 of file settings.hpp.

                    {
                StringOpt,
                BoolOpt,
                SilentOpt
        };

Constructor & Destructor Documentation

Option()

Option::Option ( Settings * settings, const std::string & name = "", OptType type = OptType::StringOpt, const std::string & param = "", const std::string & defaultValue = "", bool enabled = true )

inline

Definition at line 34 of file settings.hpp.

                                             :
                name(name),
                param(param),
                value(defaultValue),
                defaultValue(defaultValue),
                enabled(enabled),
                type(type),
                settings(settings)      {  }

~Option()

virtual Option::~Option ( )

inlinevirtual

Definition at line 48 of file settings.hpp.

{  }

Member Function Documentation

addOnChangeCallback()

void Option::addOnChangeCallback

(

Callback

callback

)

Definition at line 107 of file settings.cpp.

                                                 {
        onChangeCallbacks.push_back(callback);
}

References callback, and onChangeCallbacks.

Referenced by Settings::Settings(), SettingsUi::addCallbacks(), addSuboption(), WidgetUi::registerCustomCallback(), and UltragridWindow::setupPreviewCallbacks().

addSuboption()

void Option::addSuboption	(	Option *	sub,
		const std::string &	limit = "" )

Definition at line 96 of file settings.cpp.

                                                            {
        auto pair = std::make_pair(limit, sub);
        auto it = std::find(suboptions.begin(), suboptions.end(), pair);
 
        if(it != suboptions.end())
                return;
 
        sub->addOnChangeCallback(Callback(&Option::suboptionChanged, this));
        suboptions.push_back(pair);
}

References addOnChangeCallback(), limit, suboptionChanged(), and suboptions.

Referenced by Settings::addOption().

Here is the call graph for this function:

changed()

void Option::changed

(

)

Definition at line 60 of file settings.cpp.

                    {
        for(const auto &callback : onChangeCallbacks){
                callback(*this, false);
        }
}

References callback, and onChangeCallbacks.

Referenced by setEnabled(), and setValue().

getLaunchOption()

std::string Option::getLaunchOption ( ) const

virtual

Definition at line 46 of file settings.cpp.

                                       {
        if(type == OptType::BoolOpt){
                return enabled ? param : "";
        }
 
        std::string out = "";
        if(enabled && !value.empty() && type != OptType::SilentOpt)
                out = param + value;
 
        out += getSubVals();
 
        return out;
}

References BoolOpt, enabled, getSubVals(), param, SilentOpt, type, and value.

Referenced by Settings::getLaunchParams(), and Settings::getPreviewParams().

Here is the call graph for this function:

getName()

std::string Option::getName

(

)

const

Definition at line 22 of file settings.cpp.

                               {
        return name;
}

References name.

Referenced by CheckableUi::optChangeCallback(), RadioButtonUi::optChangeCallback(), and TextOptUi::optChangeCallback().

getParam()

std::string Option::getParam

(

)

const

Definition at line 30 of file settings.cpp.

                                {
        return param;
}

References param.

Referenced by fec_builder_callback(), Settings::getLaunchParams(), and Settings::getPreviewParams().

getSettings()

Settings * Option::getSettings

(

)

Definition at line 129 of file settings.cpp.

                             {
        return settings;
}

References settings.

Referenced by audioCompressionCallback(), fec_auto_callback(), fec_builder_callback(), and videoCompressBitrateCallback().

getSubVals()

std::string Option::getSubVals

(

)

const

Definition at line 34 of file settings.cpp.

                                  {
        std::string out;
 
        for(const auto &sub : suboptions){
                if(sub.first.empty() || sub.first == value){
                        out += sub.second->getLaunchOption();
                }
        }
 
        return out;
}

References suboptions, and value.

Referenced by getLaunchOption().

getType()

OptType Option::getType ( ) const

inline

Definition at line 54 of file settings.hpp.

{ return type; };

References type.

getValue()

std::string Option::getValue

(

)

const

Definition at line 26 of file settings.cpp.

                                {
        return value;
}

References value.

Referenced by audioCompressionCallback(), conditionsSatisfied(), fec_auto_callback(), fec_builder_callback(), Settings::getControlPort(), TextOptUi::getOptValue(), Settings::isAdvancedMode(), RadioButtonUi::optChangeCallback(), TextOptUi::optChangeCallback(), ComboBoxUi::selectOption(), RadioButtonUi::updateUiState(), and videoCompressBitrateCallback().

isEnabled()

bool Option::isEnabled ( ) const

inline

Definition at line 61 of file settings.hpp.

{ return enabled; }

References enabled.

Referenced by fec_auto_callback(), fec_builder_callback(), CheckableUi::getOptValue(), CheckableUi::optChangeCallback(), and vuMeterCallback().

removeOnChangeCallback()

void Option::removeOnChangeCallback

(

const Callback &

callback

)

Definition at line 111 of file settings.cpp.

                                                           {
        auto it = std::find(onChangeCallbacks.begin(), onChangeCallbacks.end(), callback);
 
        if(it == onChangeCallbacks.end()){
                std::cout << "Attempted to remove non-existent callback "
                        << name
                        << std::endl;
                return;
        }
 
#ifdef DEBUG
        std::cout << "Removing callback "
                << name
                << std::endl;
#endif
        onChangeCallbacks.erase(it);
}

References callback, name, and onChangeCallbacks.

Referenced by WidgetUi::~WidgetUi().

setDefaultValue()

void Option::setDefaultValue ( const std::string & val )

virtual

Definition at line 86 of file settings.cpp.

                                                {
        defaultValue = val;
}

References defaultValue, and val.

Referenced by Settings::addOption().

setEnabled()

void Option::setEnabled	(	bool	enable,
		bool	suppressCallback = false )

Definition at line 90 of file settings.cpp.

                                                         {
        enabled = enable;
        if(!suppressCallback)
                changed();
}

References changed(), and enabled.

Referenced by Settings::addOption(), and audioCompressionCallback().

Here is the call graph for this function:

setParam()

void Option::setParam ( const std::string & p )

inline

Definition at line 59 of file settings.hpp.

{ param = p; }

References param.

Referenced by Settings::addOption().

setType()

void Option::setType ( OptType type )

inline

Definition at line 64 of file settings.hpp.

{ this->type = type; };

References type.

Referenced by Settings::addOption().

setValue()

void Option::setValue ( const std::string & val, bool suppressCallback = false )

virtual

Definition at line 73 of file settings.cpp.

                                                                {
        value = val;
 
        if(type == OptType::BoolOpt){
                enabled = val == "t";
        } else {
                enabled = !val.empty();
        }
 
        if(!suppressCallback)
                changed();
}

References BoolOpt, changed(), enabled, type, val, and value.

Referenced by Settings::addOption(), CheckableUi::boxClicked(), RadioButtonUi::btnClicked(), UltragridWindow::checkPreview(), fec_auto_callback(), fec_builder_callback(), ComboBoxUi::itemSelected(), UltragridWindow::loadSettingsFile(), and TextOptUi::textEdited().

Here is the call graph for this function:

suboptionChanged()

void Option::suboptionChanged ( Option & opt, bool suboption, void * opaque )

staticprotected

Definition at line 66 of file settings.cpp.

                                                            {
        Option *obj = static_cast<Option *>(opaque);
        for(const auto &callback : obj->onChangeCallbacks){
                callback(opt, true);
        }
}

References callback, and onChangeCallbacks.

Referenced by addSuboption().

Member Data Documentation

defaultValue

std::string Option::defaultValue

protected

Definition at line 77 of file settings.hpp.

Referenced by setDefaultValue().

enabled

bool Option::enabled

protected

Definition at line 79 of file settings.hpp.

Referenced by fec_builder_callback(), getLaunchOption(), isEnabled(), setEnabled(), and setValue().

name

std::string Option::name

protected

Definition at line 74 of file settings.hpp.

Referenced by getName(), and removeOnChangeCallback().

onChangeCallbacks

std::vector<Callback> Option::onChangeCallbacks

protected

Definition at line 85 of file settings.hpp.

Referenced by addOnChangeCallback(), changed(), removeOnChangeCallback(), and suboptionChanged().

param

std::string Option::param

protected

Definition at line 75 of file settings.hpp.

Referenced by getLaunchOption(), getParam(), and setParam().

settings

Settings* Option::settings

protected

Definition at line 88 of file settings.hpp.

Referenced by fec_auto_callback(), fec_builder_callback(), and getSettings().

suboptions

std::vector<std::pair<std::string, Option *> > Option::suboptions

protected

Definition at line 86 of file settings.hpp.

Referenced by addSuboption(), and getSubVals().

type

OptType Option::type

protected

Definition at line 81 of file settings.hpp.

Referenced by fec_builder_callback(), getLaunchOption(), getType(), setType(), and setValue().

value

std::string Option::value

protected

Definition at line 76 of file settings.hpp.

Referenced by getLaunchOption(), getSubVals(), getValue(), and setValue().

---

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

• gui/QT/option/settings.hpp
• gui/QT/option/settings.cpp