ComboProperty Class Reference

Custom property to define list of string values with multiple selections. More...

Public Member Functions
	ComboProperty ()
int	currentIndex () const
QString	getValue () const
QStringList	getValues () const
QString	label () const
	Returns the label to show. More...
bool	operator!= (const ComboProperty &other) const
bool	operator< (const ComboProperty &other) const
ComboProperty &	operator<< (const QString &str)
ComboProperty &	operator<< (const QStringList &str)
bool	operator== (const ComboProperty &other) const
QVector< int >	selectedIndices () const
	Returns vector of selected indices. More...
QStringList	selectedValues () const
	Returns list of string with selected values;. More...
void	setCurrentIndex (int index)
void	setSelected (const QString &name, bool value=true)
void	setSelected (int index, bool value=true)
	Sets given index selection flag. More...
void	setStringOfSelections (const QString &values)
	Sets selected indices from string. More...
void	setStringOfValues (const QString &values)
	Sets values from the string containing delimeter ';'. More...
void	setToolTips (const QStringList &tooltips)
void	setValue (const QString &name)
void	setValues (const QStringList &values)
	Sets new list of values. Current value will be preserved, if exists in a new list. More...
QString	stringOfSelections () const
	Return string with coma separated list of selected indices. More...
QString	stringOfValues () const
	Returns a single string containing values delimited with ';'. More...
QStringList	toolTips () const
	returns list of tool tips for all values More...
QVariant	variant () const
	Constructs variant enclosing given ComboProperty. More...

Static Public Member Functions
static ComboProperty	fromList (const QStringList &values, const QString &current_value="")

Private Member Functions
	ComboProperty (QStringList values)

Private Attributes
QVector< int >	m_selected_indices
QStringList	m_tooltips
QStringList	m_values

Detailed Description

Custom property to define list of string values with multiple selections.

Intended for QVariant.

Definition at line 25 of file ComboProperty.h.

Constructor & Destructor Documentation

ComboProperty() [1/2]

ComboProperty::ComboProperty ( )

default

ComboProperty() [2/2]

ComboProperty::ComboProperty ( QStringList  values )

private

Definition at line 26 of file ComboProperty.cpp.

: m_values(std::move(values)) {}

Member Function Documentation

currentIndex()

int ComboProperty::currentIndex

(

)

const

Definition at line 78 of file ComboProperty.cpp.

{
    return m_selected_indices.empty() ? -1 : m_selected_indices.at(0);
}

References m_selected_indices.

Referenced by getValue(), ComboPropertyEditor::internIndex(), and ComboPropertyEditor::onIndexChanged().

fromList()

ComboProperty ComboProperty::fromList ( const QStringList &  values, const QString &  current_value = ""  )

static

Definition at line 28 of file ComboProperty.cpp.

{
    ComboProperty result(values);
 
    if (!current_value.isEmpty())
        result.setValue(current_value);
 
    return result;
}

References setValue().

Referenced by ParticleDistributionItem::updateLinkedParameterList(), and ParticleDistributionItem::updateMainParameterList().

Here is the call graph for this function:

getValue()

QString ComboProperty::getValue

(

)

const

Definition at line 38 of file ComboProperty.cpp.

{
    return currentIndex() < 0 ? QString() : m_values.at(currentIndex());
}

References currentIndex(), and m_values.

Referenced by SimulationOptionsItem::SimulationOptionsItem(), IntensityDataCanvas::applyPersistentSettings(), DomainObjectBuilder::buildParticleLayout(), RectangularDetectorItem::createDomainDetector(), SimulationOptionsItem::getComputationMethod(), SimulationOptionsItem::getFresnelMaterialMethod(), IntensityDataItem::getGradient(), SimulationOptionsItem::getIncludeSpecularPeak(), SimulationOptionsItem::getNumberOfThreads(), RectangularDetectorEditor::init_alignment_editors(), label(), FitParameterItem::parameterType(), SimulationOptionsItem::runPolicy(), DataItem::selectedAxesUnits(), setStringOfValues(), setValues(), RectangularDetectorItem::update_properties_appearance(), and SimulationOptionsItem::updateComboItem().

Here is the call graph for this function:

getValues()

QStringList ComboProperty::getValues

(

)

const

Definition at line 52 of file ComboProperty.cpp.

{
    return m_values;
}

References m_values.

Referenced by ComboPropertyEditor::internLabels(), RectangularDetectorItem::setDetectorAlignment(), SimulationOptionsItem::updateComboItem(), and ParticleDistributionItem::updateMainParameterList().

label()

QString ComboProperty::label

(

)

const

Returns the label to show.

Definition at line 220 of file ComboProperty.cpp.

{
    if (m_selected_indices.size() > 1) {
        return "Multiple";
    } else if (m_selected_indices.size() == 1) {
        return getValue();
    } else {
        return "None";
    }
}

References getValue(), and m_selected_indices.

Referenced by MultiComboPropertyEditor::updateBoxLabel().

Here is the call graph for this function:

operator!=()

bool ComboProperty::operator!=

(

const ComboProperty &

other

)

const

Definition at line 117 of file ComboProperty.cpp.

{
    return !(*this == other);
}

operator<()

bool ComboProperty::operator<

(

const ComboProperty &

other

)

const

Definition at line 122 of file ComboProperty.cpp.

{
    return m_selected_indices.size() < other.m_selected_indices.size()
           && m_values.size() < other.m_values.size();
}

References m_selected_indices, and m_values.

operator<<() [1/2]

ComboProperty & ComboProperty::operator<<

(

const QString &

str

)

Definition at line 92 of file ComboProperty.cpp.

{
    m_values.append(str);
    if (!m_values.empty())
        setCurrentIndex(0);
    return *this;
}

References m_values, and setCurrentIndex().

Here is the call graph for this function:

operator<<() [2/2]

ComboProperty & ComboProperty::operator<<

(

const QStringList &

str

)

Definition at line 100 of file ComboProperty.cpp.

{
    m_values.append(str);
    if (!m_values.empty())
        setCurrentIndex(0);
    return *this;
}

References m_values, and setCurrentIndex().

Here is the call graph for this function:

operator==()

bool ComboProperty::operator==

(

const ComboProperty &

other

)

const

Definition at line 108 of file ComboProperty.cpp.

{
    if (m_selected_indices != other.m_selected_indices)
        return false;
    if (m_values != other.m_values)
        return false;
    return true;
}

References m_selected_indices, and m_values.

selectedIndices()

QVector< int > ComboProperty::selectedIndices

(

)

const

Returns vector of selected indices.

Definition at line 155 of file ComboProperty.cpp.

{
    return m_selected_indices;
}

References m_selected_indices.

selectedValues()

QStringList ComboProperty::selectedValues

(

)

const

Returns list of string with selected values;.

Definition at line 162 of file ComboProperty.cpp.

{
    QStringList result;
    for (auto index : m_selected_indices)
        result.append(m_values.at(index));
    return result;
}

References m_selected_indices, and m_values.

Referenced by ParticleDistributionItem::updateLinkedParameterList().

setCurrentIndex()

void ComboProperty::setCurrentIndex

(

int

index

)

Definition at line 83 of file ComboProperty.cpp.

{
    if (index < 0 || index >= m_values.size())
        throw GUIHelpers::Error("ComboProperty::setCurrentIndex(int index) -> Error. "
                                "Invalid index");
    m_selected_indices.clear();
    m_selected_indices.push_back(index);
}

References m_selected_indices, and m_values.

Referenced by GroupItemController::createCombo(), ComboPropertyEditor::onIndexChanged(), operator<<(), setStringOfValues(), setValue(), and setValues().

setSelected() [1/2]

void ComboProperty::setSelected	(	const QString &	name,
		bool	value = true
	)

Definition at line 187 of file ComboProperty.cpp.

{
    setSelected(m_values.indexOf(name), value);
}

References m_values, RealSpace::Particles::name(), and setSelected().

Here is the call graph for this function:

setSelected() [2/2]

void ComboProperty::setSelected	(	int	index,
		bool	value = true
	)

Sets given index selection flag.

If false, index will be excluded from selection.

Definition at line 173 of file ComboProperty.cpp.

{
    if (index < 0 || index >= m_values.size())
        return;
 
    if (value) {
        if (!m_selected_indices.contains(index))
            m_selected_indices.push_back(index);
    } else {
        m_selected_indices.removeAll(index);
    }
    std::sort(m_selected_indices.begin(), m_selected_indices.end());
}

References m_selected_indices, and m_values.

Referenced by MultiComboPropertyEditor::onModelDataChanged(), setSelected(), setStringOfSelections(), and ParticleDistributionItem::updateLinkedParameterList().

setStringOfSelections()

void ComboProperty::setStringOfSelections

(

const QString &

values

)

Sets selected indices from string.

Definition at line 204 of file ComboProperty.cpp.

{
    m_selected_indices.clear();
    if (values.isEmpty())
        return;
 
    for (auto str : values.split(selection_separator)) {
        bool success(false);
        int num = str.toInt(&success);
        if (success)
            setSelected(num, true);
    }
}

References m_selected_indices, and setSelected().

Referenced by SessionXML::readProperty().

Here is the call graph for this function:

setStringOfValues()

void ComboProperty::setStringOfValues

(

const QString &

values

)

Sets values from the string containing delimeter ';'.

Definition at line 137 of file ComboProperty.cpp.

{
    QString current = getValue();
    m_values = values.split(value_separator);
    setCurrentIndex(m_values.contains(current) ? m_values.indexOf(current) : 0);
}

References getValue(), m_values, and setCurrentIndex().

Referenced by SessionXML::readProperty().

Here is the call graph for this function:

setToolTips()

void ComboProperty::setToolTips

(

const QStringList &

tooltips

)

Definition at line 73 of file ComboProperty.cpp.

{
    m_tooltips = tooltips;
}

References m_tooltips.

Referenced by SimulationOptionsItem::SimulationOptionsItem(), and MinimizerItemCatalog::algorithmCombo().

setValue()

void ComboProperty::setValue

(

const QString &

name

)

Definition at line 43 of file ComboProperty.cpp.

{
    if (!m_values.contains(name))
        throw GUIHelpers::Error("ComboProperty::setValue() -> Error. Combo doesn't contain "
                                "value "
                                + name);
    setCurrentIndex(m_values.indexOf(name));
}

References m_values, RealSpace::Particles::name(), and setCurrentIndex().

Referenced by MinimizerContainerItem::MinimizerContainerItem(), IntensityDataCanvas::applyPersistentSettings(), JobItemUtils::availableUnits(), fromList(), SimulationOptionsItem::setComputationMethod(), RectangularDetectorItem::setDetectorAlignment(), SimulationOptionsItem::setFresnelMaterialMethod(), SimulationOptionsItem::setIncludeSpecularPeak(), SimulationOptionsItem::setRunPolicy(), SimulationOptionsItem::updateComboItem(), and ParticleDistributionItem::updateMainParameterList().

Here is the call graph for this function:

setValues()

void ComboProperty::setValues

(

const QStringList &

values

)

Sets new list of values. Current value will be preserved, if exists in a new list.

Definition at line 59 of file ComboProperty.cpp.

{
    ASSERT(values.size());
    QString current = getValue();
    m_values = values;
    setCurrentIndex(m_values.contains(current) ? m_values.indexOf(current) : 0);
}

References ASSERT, getValue(), m_values, and setCurrentIndex().

Referenced by GroupItemController::createCombo().

Here is the call graph for this function:

stringOfSelections()

QString ComboProperty::stringOfSelections

(

)

const

Return string with coma separated list of selected indices.

Definition at line 194 of file ComboProperty.cpp.

{
    QStringList text;
    for (auto index : m_selected_indices)
        text.append(QString::number(index));
    return text.join(selection_separator);
}

References m_selected_indices.

Referenced by SessionXML::writeVariant().

stringOfValues()

QString ComboProperty::stringOfValues

(

)

const

Returns a single string containing values delimited with ';'.

Definition at line 130 of file ComboProperty.cpp.

{
    return m_values.join(value_separator);
}

References m_values.

Referenced by SessionXML::writeVariant().

toolTips()

QStringList ComboProperty::toolTips

(

)

const

returns list of tool tips for all values

Definition at line 68 of file ComboProperty.cpp.

{
    return m_tooltips;
}

References m_tooltips.

variant()

QVariant ComboProperty::variant

(

)

const

Constructs variant enclosing given ComboProperty.

Definition at line 146 of file ComboProperty.cpp.

{
    QVariant result;
    result.setValue(*this);
    return result;
}

Referenced by Data1DViewItem::Data1DViewItem(), DataItem::DataItem(), MinimizerContainerItem::MinimizerContainerItem(), ParticleDistributionItem::ParticleDistributionItem(), SimulationOptionsItem::SimulationOptionsItem(), IntensityDataCanvas::applyPersistentSettings(), GroupItemController::createCombo(), QREDataLoader::createOutputDataFromParsingResult(), JobModelFunctions::initDataView(), SessionXML::readProperty(), IntensityDataItem::reset(), SpecularDataItem::reset(), SimulationOptionsItem::setComputationMethod(), RectangularDetectorItem::setDetectorAlignment(), SimulationOptionsItem::setFresnelMaterialMethod(), SimulationOptionsItem::setIncludeSpecularPeak(), JobItemUtils::setIntensityItemAxesUnits(), SimulationOptionsItem::setRunPolicy(), SimulationOptionsItem::updateComboItem(), ParticleDistributionItem::updateLinkedParameterList(), and ParticleDistributionItem::updateMainParameterList().

Member Data Documentation

m_selected_indices

QVector<int> ComboProperty::m_selected_indices

private

Definition at line 70 of file ComboProperty.h.

Referenced by currentIndex(), label(), operator<(), operator==(), selectedIndices(), selectedValues(), setCurrentIndex(), setSelected(), setStringOfSelections(), and stringOfSelections().

m_tooltips

QStringList ComboProperty::m_tooltips

private

Definition at line 69 of file ComboProperty.h.

Referenced by setToolTips(), and toolTips().

m_values

QStringList ComboProperty::m_values

private

Definition at line 68 of file ComboProperty.h.

Referenced by getValue(), getValues(), operator<(), operator<<(), operator==(), selectedValues(), setCurrentIndex(), setSelected(), setStringOfValues(), setValue(), setValues(), and stringOfValues().

---

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

• /home/www/ba/GUI/coregui/Models/ComboProperty.h
• /home/www/ba/GUI/coregui/Models/ComboProperty.cpp