ModelView::ComboProperty Class Reference

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

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

Static Public Member Functions
static ComboProperty	createFrom (const std::vector< std::string > &values, const std::string &current_value={})

Private Member Functions
	ComboProperty (std::vector< std::string > values)

Private Attributes
std::vector< int >	m_selected_indices
std::vector< std::string >	m_tooltips
std::vector< std::string >	m_values

Detailed Description

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

Definition at line 27 of file comboproperty.h.

Constructor & Destructor Documentation

ComboProperty() [1/2]

ComboProperty::ComboProperty ( )

default

ComboProperty() [2/2]

ComboProperty::ComboProperty ( std::vector< std::string >  values )

private

Definition at line 59 of file comboproperty.cpp.

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

Member Function Documentation

createFrom()

ComboProperty ComboProperty::createFrom ( const std::vector< std::string > &  values, const std::string &  current_value = {}  )

static

Definition at line 61 of file comboproperty.cpp.

{
    ComboProperty result(values);
 
    if (!current_value.empty())
        result.setValue(current_value);
    else
        result.setCurrentIndex(0);
 
    return result;
}

References setCurrentIndex(), setValue(), and values().

Referenced by ToyItems::LatticeItem::LatticeItem(), and TEST_F().

Here is the call graph for this function:

currentIndex()

int ComboProperty::currentIndex

(

)

const

Definition at line 116 of file comboproperty.cpp.

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

References m_selected_indices.

Referenced by ModelView::ComboPropertyEditor::internIndex(), operator<<(), TEST_F(), and value().

label()

std::string ComboProperty::label

(

)

const

Returns the label to show.

Definition at line 248 of file comboproperty.cpp.

{
    if (m_selected_indices.size() > 1) {
        return multiple_label;
    } else if (m_selected_indices.size() == 1) {
        return value();
    } else {
        return none_label;
    }
}

References m_selected_indices, and value().

Referenced by TEST_F(), and ModelView::SelectableComboBoxEditor::updateBoxLabel().

Here is the call graph for this function:

operator!=()

bool ComboProperty::operator!=

(

const ComboProperty &

other

)

const

Definition at line 155 of file comboproperty.cpp.

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

operator<()

bool ComboProperty::operator<

(

const ComboProperty &

other

)

const

Definition at line 160 of file comboproperty.cpp.

{
    return m_selected_indices < other.m_selected_indices && m_values < other.m_values;
}

References m_selected_indices, and m_values.

operator<<() [1/2]

ComboProperty & ComboProperty::operator<<

(

const std::string &

str

)

Definition at line 130 of file comboproperty.cpp.

{
    m_values.push_back(str);
    if (currentIndex() == -1)
        setCurrentIndex(0);
    return *this;
}

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

Here is the call graph for this function:

operator<<() [2/2]

ComboProperty & ComboProperty::operator<<

(

const std::vector< std::string > &

str

)

Definition at line 138 of file comboproperty.cpp.

{
    m_values.insert(m_values.end(), str.begin(), str.end());
    if (currentIndex() == -1)
        setCurrentIndex(0);
    return *this;
}

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

Here is the call graph for this function:

operator==()

bool ComboProperty::operator==

(

const ComboProperty &

other

)

const

Definition at line 146 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()

std::vector< int > ComboProperty::selectedIndices

(

)

const

Returns vector of selected indices.

Definition at line 183 of file comboproperty.cpp.

{
    return m_selected_indices;
}

References m_selected_indices.

Referenced by TEST_F().

selectedValues()

std::vector< std::string > ComboProperty::selectedValues

(

)

const

Returns list of string with selected values;.

Definition at line 190 of file comboproperty.cpp.

{
    std::vector<std::string> result;
    for (auto index : m_selected_indices)
        result.push_back(m_values.at(static_cast<size_t>(index)));
    return result;
}

References m_selected_indices, and m_values.

Referenced by TEST_F().

setCurrentIndex()

void ComboProperty::setCurrentIndex

(

int

index

)

Definition at line 121 of file comboproperty.cpp.

{
    if (index < 0 || index >= static_cast<int>(m_values.size()))
        throw std::runtime_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 createFrom(), ModelView::GroupItem::init_group(), ModelView::ComboPropertyEditor::onIndexChanged(), operator<<(), ModelView::PenItem::setSelected(), setStringOfValues(), setValue(), setValues(), and TEST_F().

setSelected() [1/2]

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

Definition at line 217 of file comboproperty.cpp.

{
    setSelected(Utils::IndexOfItem(m_values, name), value);
}

References ModelView::Utils::IndexOfItem(), m_values, RealSpace::Particles::name(), setSelected(), and value().

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 201 of file comboproperty.cpp.

{
    if (index < 0 || index >= static_cast<int>(m_values.size()))
        return;
 
    auto pos = find(m_selected_indices.begin(), m_selected_indices.end(), index);
    if (value) {
        if (pos == m_selected_indices.end())
            m_selected_indices.push_back(index);
    } else {
        if (pos != m_selected_indices.end())
            m_selected_indices.erase(pos);
    }
    std::sort(m_selected_indices.begin(), m_selected_indices.end());
}

References m_selected_indices, m_values, and value().

Referenced by ModelView::SelectableComboBoxEditor::onModelDataChanged(), setSelected(), setStringOfSelections(), and TEST_F().

Here is the call graph for this function:

setStringOfSelections()

void ComboProperty::setStringOfSelections

(

const std::string &

values

)

Sets selected indices from string.

Definition at line 234 of file comboproperty.cpp.

{
    m_selected_indices.clear();
    if (values.empty())
        return;
 
    for (const auto& str : tokenize(values, selection_separator)) {
        int num = std::stoi(str);
        setSelected(num, true);
    }
}

References m_selected_indices, setSelected(), and values().

Referenced by TEST_F().

Here is the call graph for this function:

setStringOfValues()

void ComboProperty::setStringOfValues

(

const std::string &

values

)

Sets values from the string containing delimeter ';'.

Definition at line 174 of file comboproperty.cpp.

{
    auto current = value();
    m_values = tokenize(values, value_separator);
    setCurrentIndex(Utils::Contains(m_values, current) ? Utils::IndexOfItem(m_values, current) : 0);
}

References ModelView::Utils::Contains(), ModelView::Utils::IndexOfItem(), m_values, setCurrentIndex(), value(), and values().

Referenced by TEST_F().

Here is the call graph for this function:

setToolTips()

void ComboProperty::setToolTips

(

const std::vector< std::string > &

tooltips

)

Definition at line 111 of file comboproperty.cpp.

{
    m_tooltips = tooltips;
}

References m_tooltips.

setValue()

void ComboProperty::setValue

(

const std::string &

name

)

Definition at line 79 of file comboproperty.cpp.

{
    if (!Utils::Contains(m_values, name))
        throw std::runtime_error("ComboProperty::setValue() -> Error. Combo doesn't contain "
                                 "value "
                                 + name);
    setCurrentIndex(Utils::IndexOfItem(m_values, name));
}

References ModelView::Utils::Contains(), ModelView::Utils::IndexOfItem(), m_values, RealSpace::Particles::name(), and setCurrentIndex().

Referenced by createFrom(), and TEST_F().

Here is the call graph for this function:

setValues()

void ComboProperty::setValues

(

const std::vector< std::string > &

values

)

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

Definition at line 95 of file comboproperty.cpp.

{
    if (values.empty())
        return;
 
    auto current = value();
    m_values = values;
    setCurrentIndex(Utils::Contains(m_values, current) ? Utils::IndexOfItem(m_values, current) : 0);
}

References ModelView::Utils::Contains(), ModelView::Utils::IndexOfItem(), m_values, setCurrentIndex(), value(), and values().

Referenced by ModelView::GroupItem::init_group(), and TEST_F().

Here is the call graph for this function:

stringOfSelections()

std::string ComboProperty::stringOfSelections

(

)

const

Return string with coma separated list of selected indices.

Definition at line 224 of file comboproperty.cpp.

{
    std::vector<std::string> text;
    for (auto index : m_selected_indices)
        text.push_back(std::to_string(index));
    return toString(text, selection_separator);
}

References m_selected_indices, and PyUtils::toString().

Referenced by TEST_F().

Here is the call graph for this function:

stringOfValues()

std::string ComboProperty::stringOfValues

(

)

const

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

Definition at line 167 of file comboproperty.cpp.

{
    return toString(m_values, value_separator);
}

References m_values, and PyUtils::toString().

Referenced by TEST_F().

Here is the call graph for this function:

toolTips()

std::vector< std::string > ComboProperty::toolTips

(

)

const

returns list of tool tips for all values

Definition at line 106 of file comboproperty.cpp.

{
    return m_tooltips;
}

References m_tooltips.

Referenced by TEST_F().

value()

std::string ComboProperty::value

(

)

const

Definition at line 74 of file comboproperty.cpp.

{
    return currentIndex() < 0 ? std::string() : m_values.at(static_cast<size_t>(currentIndex()));
}

References currentIndex(), and m_values.

Referenced by ModelView::DefaultCellDecorator::cellText(), label(), setSelected(), setStringOfValues(), setValues(), and TEST_F().

Here is the call graph for this function:

values()

std::vector< std::string > ComboProperty::values

(

)

const

Definition at line 88 of file comboproperty.cpp.

{
    return m_values;
}

References m_values.

Referenced by createFrom(), ModelView::ComboPropertyEditor::internLabels(), setStringOfSelections(), setStringOfValues(), setValues(), and TEST_F().

Member Data Documentation

m_selected_indices

std::vector<int> ModelView::ComboProperty::m_selected_indices

private

Definition at line 71 of file comboproperty.h.

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

m_tooltips

std::vector<std::string> ModelView::ComboProperty::m_tooltips

private

Definition at line 70 of file comboproperty.h.

Referenced by setToolTips(), and toolTips().

m_values

std::vector<std::string> ModelView::ComboProperty::m_values

private

Definition at line 69 of file comboproperty.h.

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

---

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

• /home/www/ba/mvvm/model/mvvm/model/comboproperty.h
• /home/www/ba/mvvm/model/mvvm/model/comboproperty.cpp