KisCmbIDList Class Reference

#include <kis_cmb_idlist.h>

Inheritance diagram for KisCmbIDList:

Signals
void	activated (const KoID &)
void	highlighted (const KoID &)

Public Member Functions
void	allowAuto (bool setAuto=true)
	allowAuto sets whether the combobox should keep an extra "AUTO" option, where the use allows the program to decide an appropriate option based on context.
KoID	currentItem () const
	KisCmbIDList (QWidget *parent=0, const char *name=0)
void	setAutoHint (const QString &hint)
void	setCurrent (const KoID id)
void	setCurrent (const QString &id)
void	setIDList (const QList< KoID > &list, bool sorted=true)
	setIDList clears the combobox and sorts the given list by user-visible name and then adds the items to the combobox
	~KisCmbIDList () override

Static Public Attributes
static const KoID	AutoOptionID = KoID("AUTO", ki18nc("Automatic", "Auto"))

Private Slots
void	slotIDActivated (int index)
void	slotIDHighlighted (int index)

Private Member Functions
void	buildItems ()

Private Attributes
QString	m_autoHint
bool	m_autoOption = false
QList< KoID >	m_idList
bool	m_sorted = true

Detailed Description

A combobox that is associated with a list of KoID's. The descriptive (i18n'ed) text is displayed, but the various signals return a KoID.

Definition at line 23 of file kis_cmb_idlist.h.

Constructor & Destructor Documentation

KisCmbIDList()

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

Definition at line 15 of file kis_cmb_idlist.cc.

    : QComboBox(parent)
{
    setObjectName(name);
    setEditable(false);
    connect(this, SIGNAL(activated(int)), this, SLOT(slotIDActivated(int)));
    connect(this, SIGNAL(highlighted(int)), this, SLOT(slotIDHighlighted(int)));
}

References activated(), connect(), highlighted(), slotIDActivated(), and slotIDHighlighted().

~KisCmbIDList()

KisCmbIDList::~KisCmbIDList ( )

override

Definition at line 24 of file kis_cmb_idlist.cc.

{
}

Member Function Documentation

activated

void KisCmbIDList::activated ( const KoID & )

signal

allowAuto()

void KisCmbIDList::allowAuto

(

bool

setAuto = true

)

allowAuto sets whether the combobox should keep an extra "AUTO" option, where the use allows the program to decide an appropriate option based on context.

Definition at line 38 of file kis_cmb_idlist.cc.

{
    m_autoOption = setAuto;
 
    buildItems();
}

References buildItems(), and m_autoOption.

buildItems()

void KisCmbIDList::buildItems ( )

private

Definition at line 98 of file kis_cmb_idlist.cc.

{
    const KoID selectedID = currentItem();
 
    clear();
 
    // m_idList has auto, remove it temporarily.
    if (m_idList.contains(AutoOptionID)) {
        m_idList.removeAll(AutoOptionID);
    }
 
    // Sort id list..
    if (m_sorted) {
        std::sort(m_idList.begin(), m_idList.end(), KoID::compareNames);
    }
 
    // Re-add "Auto" option to front of list if auto enabled..
    if (m_autoOption) {
        m_idList.insert(0, AutoOptionID);
    }
 
    // Populate GUI item list..
    for (qint32 i = 0; i < m_idList.count(); ++i) {
        const KoID &id = m_idList.at(i);
        if (id == AutoOptionID && !m_autoHint.isEmpty()) {
            addItem(QString("%1 (%2)").arg(id.name(), m_autoHint));
        } else {
            addItem(m_idList.at(i).name());
        }
    }
 
    setCurrent(selectedID);
}

References AutoOptionID, KoID::compareNames(), currentItem(), m_autoHint, m_autoOption, m_idList, m_sorted, and setCurrent().

currentItem()

KoID KisCmbIDList::currentItem

(

)

const

Definition at line 52 of file kis_cmb_idlist.cc.

{
    qint32 index = QComboBox::currentIndex();
 
    if (index > m_idList.count() - 1 || index < 0) return KoID();
 
    return m_idList[index];
}

References m_idList.

highlighted

void KisCmbIDList::highlighted ( const KoID & )

signal

setAutoHint()

void KisCmbIDList::setAutoHint

(

const QString &

hint

)

Definition at line 45 of file kis_cmb_idlist.cc.

{
    m_autoHint = hint;
 
    buildItems();
}

References buildItems(), and m_autoHint.

setCurrent() [1/2]

void KisCmbIDList::setCurrent

(

const KoID

id

)

Definition at line 61 of file kis_cmb_idlist.cc.

{
    qint32 index = m_idList.indexOf(id);
 
    if (index >= 0) {
        QComboBox::setCurrentIndex(index);
    } else if (id != KoID()) {
        m_idList.push_back(id);
        buildItems();
        QComboBox::setCurrentIndex(m_idList.indexOf(id));
    }
}

References buildItems(), and m_idList.

setCurrent() [2/2]

void KisCmbIDList::setCurrent

(

const QString &

id

)

Definition at line 74 of file kis_cmb_idlist.cc.

{
    for (qint32 index = 0; index < m_idList.count(); ++index) {
        if (m_idList.at(index).id() == id) {
            QComboBox::setCurrentIndex(index);
            break;
        }
    }
}

References m_idList.

setIDList()

void KisCmbIDList::setIDList	(	const QList< KoID > &	list,
		bool	sorted = true )

setIDList clears the combobox and sorts the given list by user-visible name and then adds the items to the combobox

Parameters

list	the (unsorted) list of KoID's
sorted	if true, the id's will be sorted by name

Definition at line 30 of file kis_cmb_idlist.cc.

{
    m_idList = list;
    m_sorted = sorted;
 
    buildItems();
}

References buildItems(), m_idList, and m_sorted.

slotIDActivated

void KisCmbIDList::slotIDActivated ( int index )

privateslot

Definition at line 84 of file kis_cmb_idlist.cc.

{
    if (index > m_idList.count() - 1 || index < 0) return;
 
    Q_EMIT activated(m_idList[index]);
}

References activated(), and m_idList.

slotIDHighlighted

void KisCmbIDList::slotIDHighlighted ( int index )

privateslot

Definition at line 91 of file kis_cmb_idlist.cc.

{
    if (index > m_idList.count() - 1 || index < 0) return;
 
    Q_EMIT highlighted(m_idList[index]);
}

References highlighted(), and m_idList.

Member Data Documentation

AutoOptionID

const KoID KisCmbIDList::AutoOptionID = KoID("AUTO", ki18nc("Automatic", "Auto"))

static

Definition at line 31 of file kis_cmb_idlist.h.

m_autoHint

QString KisCmbIDList::m_autoHint

private

Definition at line 70 of file kis_cmb_idlist.h.

m_autoOption

bool KisCmbIDList::m_autoOption = false

private

Definition at line 69 of file kis_cmb_idlist.h.

m_idList

QList<KoID> KisCmbIDList::m_idList

private

Definition at line 67 of file kis_cmb_idlist.h.

m_sorted

bool KisCmbIDList::m_sorted = true

private

Definition at line 68 of file kis_cmb_idlist.h.

---

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

• libs/ui/widgets/kis_cmb_idlist.h
• libs/ui/widgets/kis_cmb_idlist.cc