KisSqueezedComboBox Class Reference

#include <KisSqueezedComboBox.h>

Inheritance diagram for KisSqueezedComboBox:

Public Member Functions
void	addSqueezedItem (const QIcon &icon, const QString &newItem, QVariant userData=QVariant())
void	addSqueezedItem (const QString &newItem, QVariant userData=QVariant())
bool	contains (const QString &text) const
QString	currentUnsqueezedText ()
qint32	findOriginalText (const QString &text) const
void	insertSqueezedItem (const QIcon &icon, const QString &newItem, int index, QVariant userData=QVariant())
void	insertSqueezedItem (const QString &newItem, int index, QVariant userData=QVariant())
	KisSqueezedComboBox (QWidget *parent=0, const char *name=0)
QStringList	originalTexts () const
void	removeSqueezedItem (int index)
void	resetOriginalTexts (const QStringList &texts)
void	setCurrent (const QString &itemText)
QSize	sizeHint () const override
	~KisSqueezedComboBox () override

Static Public Member Functions
static QString	squeezeText (const QString &original, const QWidget *widget)

Private Slots
void	slotTimeOut ()

Private Member Functions
void	addItem (const QString &text)
void	insertItem (const QString &text)
void	insertItem (qint32 index, const QString &text)
void	resizeEvent (QResizeEvent *) override
void	setCurrentText (const QString &itemText)

Private Attributes
QMap< int, QString >	m_originalItems
QTimer *	m_timer

Detailed Description

This widget is a QComboBox, but then a little bit different. It only shows the right part of the items depending on de size of the widget. When it is not possible to show the complete item, it will be shortened and "..." will be prepended.

This is how it looks

Author

Tom Albers

Definition at line 38 of file KisSqueezedComboBox.h.

Constructor & Destructor Documentation

KisSqueezedComboBox()

KisSqueezedComboBox::KisSqueezedComboBox	(	QWidget *	parent = 0,
		const char *	name = 0 )

Constructor

Parameters

parent	parent widget
name	name to give to the widget

Definition at line 23 of file KisSqueezedComboBox.cpp.

        : QComboBox(parent)
{
    setObjectName(name);
    setMinimumWidth(100);
    m_timer = new QTimer(this);
    m_timer->setSingleShot(true);
    connect(m_timer, SIGNAL(timeout()),
            SLOT(slotTimeOut()));
}

References connect(), m_timer, and slotTimeOut().

~KisSqueezedComboBox()

KisSqueezedComboBox::~KisSqueezedComboBox ( )

override

destructor

Definition at line 34 of file KisSqueezedComboBox.cpp.

{
    delete m_timer;
}

References m_timer.

Member Function Documentation

addItem()

void KisSqueezedComboBox::addItem ( const QString & text )

private

addSqueezedItem() [1/2]

void KisSqueezedComboBox::addSqueezedItem	(	const QIcon &	icon,
		const QString &	newItem,
		QVariant	userData = QVariant() )

Append an item.

Parameters

icon	the item icon
newItem	the original (long version) of the item which needs to be added to the combobox
userData	the user data

Definition at line 112 of file KisSqueezedComboBox.cpp.

{
    insertSqueezedItem(icon, newItem, count(), userData);
}

References insertSqueezedItem().

addSqueezedItem() [2/2]

void KisSqueezedComboBox::addSqueezedItem	(	const QString &	newItem,
		QVariant	userData = QVariant() )

Append an item.

Parameters

newItem	the original (long version) of the item which needs to be added to the combobox
userData	the user data.

Definition at line 107 of file KisSqueezedComboBox.cpp.

{
    insertSqueezedItem(newItem, count(), userData);
}

References insertSqueezedItem().

contains()

bool KisSqueezedComboBox::contains

(

const QString &

text

)

const

Returns true if the combobox contains the original (not-squeezed) version of text.

Parameters

text	the original (not-squeezed) text to check for

Definition at line 39 of file KisSqueezedComboBox.cpp.

{
    if (_text.isEmpty())
        return false;
 
    for (QMap<int, QString>::const_iterator it = m_originalItems.begin() ; it != m_originalItems.end();
            ++it) {
        if (it.value() == _text) {
            return true;
        }
    }
    return false;
}

References m_originalItems.

currentUnsqueezedText()

QString KisSqueezedComboBox::currentUnsqueezedText

(

)

This method returns the full text (not squeezed) of the currently highlighted item.

Returns

full text of the highlighted item

Definition at line 160 of file KisSqueezedComboBox.cpp.

{
    int curItem = currentIndex();
    return m_originalItems[curItem];
}

References m_originalItems.

findOriginalText()

qint32 KisSqueezedComboBox::findOriginalText

(

const QString &

text

)

const

Returns index of a original text, -1 if the text isn't found

Parameters

text	the original (not-squeezed) text to search for

Definition at line 53 of file KisSqueezedComboBox.cpp.

{
    for (int i = 0; i < m_originalItems.size(); i++) {
        if(m_originalItems.value(i) == text) {
            return i;
        }
    }
    return -1;
}

References m_originalItems.

insertItem() [1/2]

void KisSqueezedComboBox::insertItem ( const QString & text )

private

insertItem() [2/2]

void KisSqueezedComboBox::insertItem ( qint32 index, const QString & text )

private

insertSqueezedItem() [1/2]

void KisSqueezedComboBox::insertSqueezedItem	(	const QIcon &	icon,
		const QString &	newItem,
		int	index,
		QVariant	userData = QVariant() )

Definition at line 100 of file KisSqueezedComboBox.cpp.

{
    m_originalItems[index] = newItem;
    QComboBox::insertItem(index, icon, squeezeText(newItem, this), userData);
    setItemData(index, newItem, Qt::ToolTipRole);
}

References m_originalItems, and squeezeText().

insertSqueezedItem() [2/2]

void KisSqueezedComboBox::insertSqueezedItem	(	const QString &	newItem,
		int	index,
		QVariant	userData = QVariant() )

This inserts a item to the list. See QComboBox::insertItem() for details. Please do not use QComboBox::insertItem() to this widget, as that will fail.

Parameters

newItem	the original (long version) of the item which needs to be added to the combobox
index	the position in the widget.
userData	the user data.

Definition at line 93 of file KisSqueezedComboBox.cpp.

{
    m_originalItems[index] = newItem;
    QComboBox::insertItem(index, squeezeText(newItem, this), userData);
    setItemData(index, newItem, Qt::ToolTipRole);
}

References m_originalItems, and squeezeText().

originalTexts()

QStringList KisSqueezedComboBox::originalTexts

(

)

const

Return the list of original text items

Definition at line 63 of file KisSqueezedComboBox.cpp.

{
    return m_originalItems.values();
}

References m_originalItems.

removeSqueezedItem()

void KisSqueezedComboBox::removeSqueezedItem

(

int

index

)

remove the squeezed item at index

Definition at line 166 of file KisSqueezedComboBox.cpp.

{
    removeItem(index);
    m_originalItems.remove(index);
}

References m_originalItems.

resetOriginalTexts()

void KisSqueezedComboBox::resetOriginalTexts

(

const QStringList &

texts

)

Reset the combo box and initialize it with the list of (original) text items

Definition at line 68 of file KisSqueezedComboBox.cpp.

{
    if (texts == m_originalItems.values()) return;
 
    clear();
    m_originalItems.clear();
 
    Q_FOREACH (const QString &item, texts) {
        addSqueezedItem(item);
    }
}

References addSqueezedItem(), and m_originalItems.

resizeEvent()

void KisSqueezedComboBox::resizeEvent ( QResizeEvent * )

overrideprivate

Definition at line 125 of file KisSqueezedComboBox.cpp.

{
    m_timer->start(200);
}

References m_timer.

setCurrent()

void KisSqueezedComboBox::setCurrent

(

const QString &

itemText

)

Set the current item to the one matching the given text.

Parameters

itemText

the original (long version) of the item text

Definition at line 117 of file KisSqueezedComboBox.cpp.

{
    qint32 itemIndex = findOriginalText(itemText);
    if (itemIndex >= 0) {
        setCurrentIndex(itemIndex);
    }
}

References findOriginalText().

setCurrentText()

void KisSqueezedComboBox::setCurrentText ( const QString & itemText )

private

sizeHint()

QSize KisSqueezedComboBox::sizeHint ( ) const

override

Sets the sizeHint() of this widget.

Definition at line 80 of file KisSqueezedComboBox.cpp.

{
    ensurePolished();
    QFontMetrics fm = fontMetrics();
    int maxW = count() ? 18 : 7 * fm.boundingRect(QChar('x')).width() + 18;
    int maxH = qMax(fm.lineSpacing(), 14) + 2;
 
    QStyleOptionComboBox options;
    options.initFrom(this);
 
    return style()->sizeFromContents(QStyle::CT_ComboBox, &options, QSize(maxW, maxH), this);
}

slotTimeOut

void KisSqueezedComboBox::slotTimeOut ( )

privateslot

Definition at line 130 of file KisSqueezedComboBox.cpp.

{
    for (QMap<int, QString>::iterator it = m_originalItems.begin() ; it != m_originalItems.end();
            ++it) {
        setItemText(it.key(), squeezeText(it.value(), this));
    }
}

References m_originalItems, and squeezeText().

squeezeText()

QString KisSqueezedComboBox::squeezeText ( const QString & original, const QWidget * widget )

static

Definition at line 138 of file KisSqueezedComboBox.cpp.

{
    // not the complete widgetSize is usable. Need to compensate for that.
    int widgetSize = widget->width() - 30;
    QFontMetrics fm(widget->fontMetrics());
 
    // If we can fit the full text, return that.
    if (fm.boundingRect(original).width() < widgetSize)
        return(original);
 
    // We need to squeeze.
    QString sqItem = original; // prevent empty return value;
    widgetSize = widgetSize - fm.boundingRect("...").width();
    for (int i = 0 ; i != original.length(); ++i) {
        if ((int)fm.boundingRect(original.right(i)).width() > widgetSize) {
            sqItem = QString("..." + original.right(--i));
            break;
        }
    }
    return sqItem;
}

Member Data Documentation

m_originalItems

QMap<int, QString> KisSqueezedComboBox::m_originalItems

private

Definition at line 147 of file KisSqueezedComboBox.h.

m_timer

QTimer* KisSqueezedComboBox::m_timer

private

Definition at line 148 of file KisSqueezedComboBox.h.

---

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

• libs/widgetutils/KisSqueezedComboBox.h
• libs/widgetutils/KisSqueezedComboBox.cpp