Kwave::KeywordWidget Class Reference

#include <KeywordWidget.h>

Inheritance diagram for Kwave::KeywordWidget:

Collaboration diagram for Kwave::KeywordWidget:

Signals
void	autoGenerate ()

Public Member Functions
	KeywordWidget (QWidget *parent)
virtual	~KeywordWidget () Q_DECL_OVERRIDE
QStringList	keywords ()
void	setKeywords (const QStringList &keywords)

Protected Member Functions
bool	contained (const QString &item)
void	update ()
virtual bool	eventFilter (QObject *sender, QEvent *event) Q_DECL_OVERRIDE

Private Slots
void	editChanged (const QString &)
void	returnPressed ()
void	add ()
void	remove ()
void	listClicked (QListWidgetItem *item)
void	autoClicked ()

Detailed Description

Re-implemented and slightly modified version of a KEditListBox. All items in the list are unique and sorted alphabetically, leading and trailing whitespaces are removed. An additional "Auto" button is provided for populating the list with automatically generated entries.

Definition at line 40 of file KeywordWidget.h.

Constructor & Destructor Documentation

KeywordWidget()

Kwave::KeywordWidget::KeywordWidget ( QWidget *  parent )

explicit

Constructor

Definition at line 29 of file KeywordWidget.cpp.

References add(), autoClicked(), Kwave::connect(), editChanged(), listClicked(), and update().

    :QWidget(parent), Ui::KeywordWidgetBase()
{
    setupUi(this);

    Q_ASSERT(edKeyword);
    Q_ASSERT(btAdd);
    Q_ASSERT(btAuto);
    Q_ASSERT(btRemove);
    Q_ASSERT(lstKeywords);

    connect(edKeyword, SIGNAL(textChanged(QString)),
            this, SLOT(editChanged(QString)));
    connect(btAdd, SIGNAL(clicked()),
            this, SLOT(add()));
    connect(btAuto, SIGNAL(clicked()),
            this, SLOT(autoClicked()));
    connect(btRemove, SIGNAL(clicked()),
            this, SLOT(remove()));
    connect(lstKeywords, SIGNAL(itemActivated(QListWidgetItem*)),
            this, SLOT(listClicked(QListWidgetItem*)));
    connect(lstKeywords, SIGNAL(itemClicked(QListWidgetItem*)),
            this, SLOT(listClicked(QListWidgetItem*)));
    connect(lstKeywords, SIGNAL(itemDoubleClicked(QListWidgetItem*)),
            this, SLOT(listClicked(QListWidgetItem*)));

    // if the user presses return in the edit control, this means
    // the same as clicking on the "Add" button
    edKeyword->installEventFilter(this);

    update();
}

Here is the call graph for this function:

~KeywordWidget()

Kwave::KeywordWidget::~KeywordWidget ( )

virtual

Destructor

Definition at line 63 of file KeywordWidget.cpp.

{
}

Member Function Documentation

add

void Kwave::KeywordWidget::add ( )

privateslot

add an entry to the list

Definition at line 149 of file KeywordWidget.cpp.

References contained(), and update().

Referenced by eventFilter(), KeywordWidget(), and returnPressed().

{
    QString text = edKeyword->text().simplified();
    if (!text.length()) return;
    if (contained(text)) return;

    // insert the current edit text and sort the list
    lstKeywords->addItem(text);
    lstKeywords->sortItems();

    // find the new item again and make it the current selection
    QList<QListWidgetItem *> matches =
        lstKeywords->findItems(text, Qt::MatchStartsWith);
    if (!matches.isEmpty())
        lstKeywords->setCurrentItem(matches.takeFirst());
    edKeyword->clear();

    // now we do no longer need the edit
    update();
    edKeyword->clear();
}

Here is the call graph for this function:

Here is the caller graph for this function:

autoClicked

void Kwave::KeywordWidget::autoClicked ( )

privateslot

forwards the click of the "Auto" button

Definition at line 198 of file KeywordWidget.cpp.

References autoGenerate().

Referenced by KeywordWidget().

{
    emit autoGenerate();
}

Here is the caller graph for this function:

autoGenerate

void Kwave::KeywordWidget::autoGenerate ( )

signal

emitted if the user pressed the "Auto" button

Referenced by autoClicked().

Here is the caller graph for this function:

contained()

bool Kwave::KeywordWidget::contained ( const QString &  item )

protected

returns true if the given string is contained in the list

Definition at line 68 of file KeywordWidget.cpp.

Referenced by add(), setKeywords(), and update().

{
    if (!item.length()) return false;
    return (!lstKeywords->findItems(item, Qt::MatchExactly).isEmpty());
}

Here is the caller graph for this function:

editChanged

void Kwave::KeywordWidget::editChanged ( const QString &  edit )

privateslot

updates the controls if the text edit changed

Definition at line 128 of file KeywordWidget.cpp.

References update().

Referenced by KeywordWidget().

{
    QString text = edit.simplified();
    QList<QListWidgetItem *> matches =
        lstKeywords->findItems(text, Qt::MatchStartsWith);
    if (edit.length() && !matches.isEmpty()) {
        lstKeywords->setCurrentItem(matches.takeFirst());
        update();
        edKeyword->setText(edit);
    } else {
        update();
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

eventFilter()

bool Kwave::KeywordWidget::eventFilter ( QObject *  sender, QEvent *  event  )

protectedvirtual

event filter for blocking the effect of pressing "return"

Definition at line 204 of file KeywordWidget.cpp.

References add().

{
    if (!event) return false;

    if ((sender == edKeyword) && (event->type() == QEvent::KeyPress)) {
        QKeyEvent *k = static_cast<QKeyEvent *>(event);
        if ((k->key() == Qt::Key_Return) || (k->key() == Qt::Key_Enter)) {
            add();
            return true;
        }
    }
    return QObject::eventFilter(sender, event);
}

Here is the call graph for this function:

keywords()

QStringList Kwave::KeywordWidget::keywords

(

)

Returns the list of keywords (sorted)

Definition at line 75 of file KeywordWidget.cpp.

{
    QStringList list;
    unsigned int count = lstKeywords->count();
    for (unsigned int index=0; index < count; ++index) {
        QListWidgetItem *item = lstKeywords->item(index);
        if (item && item->text().length())
            list.append(item->text());
    }
    return list;
}

listClicked

void Kwave::KeywordWidget::listClicked ( QListWidgetItem *  item )

privateslot

called when a new list entry has been selected

Definition at line 190 of file KeywordWidget.cpp.

References update().

Referenced by KeywordWidget().

{
    if (!item) return;
    edKeyword->setText(item->text());
    update();
}

Here is the call graph for this function:

Here is the caller graph for this function:

remove

void Kwave::KeywordWidget::remove ( )

privateslot

remove the currently selected item from the list

Definition at line 172 of file KeywordWidget.cpp.

References update().

{
    // remove the item from the list
    int index = lstKeywords->currentRow();
    QListWidgetItem *item = lstKeywords->takeItem(index);
    if (item) delete item;
    edKeyword->clear();

    // set the previous item as current
    if (index) --index;
    if (lstKeywords->item(index))
        lstKeywords->item(index)->setSelected(true);

    edKeyword->clear();
    update();
}

Here is the call graph for this function:

returnPressed

void Kwave::KeywordWidget::returnPressed ( )

privateslot

called if the user pressed return in the edit line

Definition at line 143 of file KeywordWidget.cpp.

References add().

{
    add(); // means the same as pressing "Add"
}

Here is the call graph for this function:

setKeywords()

void Kwave::KeywordWidget::setKeywords

(

const QStringList &

keywords

)

Sets/initializes the list of keywords

Definition at line 88 of file KeywordWidget.cpp.

References contained(), and update().

{
    lstKeywords->clear();
    edKeyword->clear();

    foreach (const QString &it, keywords) {
        QString item = it.simplified();
        if (contained(item)) continue; // skip duplicate
        lstKeywords->addItem(item);
    }
    lstKeywords->setSortingEnabled(true);
    lstKeywords->sortItems();

    edKeyword->clear();
    update();
    edKeyword->clear();
}

Here is the call graph for this function:

update()

void Kwave::KeywordWidget::update ( )

protected

update the enable state of the buttons

Definition at line 107 of file KeywordWidget.cpp.

References contained().

Referenced by add(), editChanged(), KeywordWidget(), listClicked(), remove(), and setKeywords().

{
    QString edit = edKeyword->text().simplified();

    // "Add" is only allowed if the current edit space is not empty and
    // the entered text is not already in the list
    btAdd->setEnabled(edit.length() && !contained(edit));

    // "Remove" is only enabled if something out of the list has been selected
    btRemove->setEnabled((lstKeywords->currentItem() != Q_NULLPTR) &&
                         (contained(edit) || !edit.length()));

    // the list is only enabled if it is not empty
    lstKeywords->setEnabled(lstKeywords->count() != 0);

    // the current item should always be visible
    lstKeywords->scrollToItem(lstKeywords->currentItem(),
                              QAbstractItemView::EnsureVisible);
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• plugins/fileinfo/KeywordWidget.h
• plugins/fileinfo/KeywordWidget.cpp