ComboProperty Class Reference

Description

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

Definition at line 25 of file ComboProperty.h.

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. If false, index will be excluded from selection. 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

Constructor & Destructor Documentation

ComboProperty() [1/2]

ComboProperty::ComboProperty ( )

default

ComboProperty() [2/2]

ComboProperty::ComboProperty ( QStringList  values )

private

Definition at line 28 of file ComboProperty.cpp.

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

Member Function Documentation

currentIndex()

int ComboProperty::currentIndex

(

)

const

Definition at line 83 of file ComboProperty.cpp.

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

References m_selected_indices.

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

fromList()

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

static

Definition at line 33 of file ComboProperty.cpp.

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

References setValue().

Referenced by DataItem::DataItem().

Here is the call graph for this function:

getValue()

QString ComboProperty::getValue

(

)

const

Definition at line 43 of file ComboProperty.cpp.

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

References currentIndex(), and m_values.

Referenced by IntensityDataCanvas::applyPersistentSettings(), IntensityDataItem::getGradientValue(), label(), FitParameterItem::parameterType(), setStringOfValues(), and setValues().

Here is the call graph for this function:

getValues()

QStringList ComboProperty::getValues

(

)

const

Definition at line 57 of file ComboProperty.cpp.

{
    return m_values;
}

References m_values.

Referenced by ComboPropertyEditor::internLabels().

label()

QString ComboProperty::label

(

)

const

Returns the label to show.

Definition at line 225 of file ComboProperty.cpp.

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

References getValue(), and m_selected_indices.

Here is the call graph for this function:

operator!=()

bool ComboProperty::operator!=

(

const ComboProperty &

other

)

const

Definition at line 122 of file ComboProperty.cpp.

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

References other.

operator<()

bool ComboProperty::operator<

(

const ComboProperty &

other

)

const

Definition at line 127 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, m_values, and other.

operator<<() [1/2]

ComboProperty & ComboProperty::operator<<

(

const QString &

str

)

Definition at line 97 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 105 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 113 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, m_values, and other.

selectedIndices()

QVector< int > ComboProperty::selectedIndices

(

)

const

Returns vector of selected indices.

Definition at line 160 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 167 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.

setCurrentIndex()

void ComboProperty::setCurrentIndex

(

int

index

)

Definition at line 88 of file ComboProperty.cpp.

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

References Error, m_selected_indices, and m_values.

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

setSelected() [1/2]

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

Definition at line 192 of file ComboProperty.cpp.

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

References m_values, GUI::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 178 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 setSelected(), and setStringOfSelections().

setStringOfSelections()

void ComboProperty::setStringOfSelections

(

const QString &

values

)

Sets selected indices from string.

Definition at line 209 of file ComboProperty.cpp.

{
    m_selected_indices.clear();
    if (values.isEmpty())
        return;
 
    for (const 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 GUI::Session::XML::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 142 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 GUI::Session::XML::readProperty().

Here is the call graph for this function:

setToolTips()

void ComboProperty::setToolTips

(

const QStringList &

tooltips

)

Definition at line 78 of file ComboProperty.cpp.

{
    m_tooltips = tooltips;
}

References m_tooltips.

Referenced by MinimizerItemCatalog::algorithmCombo().

setValue()

void ComboProperty::setValue

(

const QString &

name

)

Definition at line 48 of file ComboProperty.cpp.

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

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

Referenced by MinimizerContainerItem::MinimizerContainerItem(), IntensityDataCanvas::applyPersistentSettings(), GUI::Model::JobItemUtils::availableUnits(), and fromList().

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 64 of file ComboProperty.cpp.

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

References 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 199 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.

stringOfValues()

QString ComboProperty::stringOfValues

(

)

const

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

Definition at line 135 of file ComboProperty.cpp.

{
    return m_values.join(value_separator);
}

References m_values.

toolTips()

QStringList ComboProperty::toolTips

(

)

const

Returns list of tool tips for all values.

Definition at line 73 of file ComboProperty.cpp.

{
    return m_tooltips;
}

References m_tooltips.

variant()

QVariant ComboProperty::variant

(

)

const

Constructs variant enclosing given ComboProperty.

Definition at line 151 of file ComboProperty.cpp.

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

Referenced by MinimizerContainerItem::MinimizerContainerItem(), GroupItemController::createCombo(), GUI::Session::XML::readProperty(), Data1DViewItem::setAxesUnits(), and DataItem::setAxesUnits().

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/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Util/ComboProperty.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Util/ComboProperty.cpp