Class Scine::Utils::UniversalSettings::StringListDescriptor

class StringListDescriptor : public Scine::Utils::UniversalSettings::SettingDescriptor

SettingDescriptor for a list of strings.

Public Functions

std::unique_ptr<SettingDescriptor> clone() const

Create a heap-allocated base pointer copy of this instance.

Return

A heap-allocated copy of this instance

GenericValue getDefaultGenericValue() const

Creates a type-erased representation of the setting’s default value.

Return

A type-erased representation of the setting’s default value

bool validValue(const GenericValue &v) const

Checks if a particular type-erased representation of a setting is a valid value for this kind of setting.

Return

Whether the type-erased representation is a valid value for this kind of setting

Parameters
  • v: A type-erased setting representation

StringListDescriptor::StringList getDefaultValue() const

Returns the default string list value.

void setDefaultValue(StringList def)

Sets the default string list value.

std::string getDefaultItemValue() const

Returns the default value for an individual string in the list.

void setDefaultItemValue(std::string def)

Get the default value for an individual string in the list.