keditlistbox.cpp

/* This file is part of the KDE libraries
   Copyright (C) 2000 David Faure <[email protected]>, Alexander Neundorf <[email protected]>
   2000, 2002 Carsten Pfeiffer <[email protected]>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.
 
   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.
 
   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/
 
#include "keditlistbox.h"
 
#include <QStringList>
#include <QKeyEvent>
#include <QLabel>
#include <QLayout>
#include <QListView>
#include <QPushButton>
 
#include <kcombobox.h>
#include <kdebug.h>
#include <klineedit.h>
#include <klocalizedstring.h>
#include <knotification.h>
 
#include <assert.h>
 
class KEditListBoxPrivate
{
public:
    KEditListBoxPrivate(KEditListBox *parent)
        : lineEdit(nullptr),
          editingWidget(nullptr),
          q(parent)
    {
    }
    QListView *listView;
    QPushButton *servUpButton, *servDownButton;
    QPushButton *servNewButton, *servRemoveButton;
    KLineEdit *lineEdit;
    QWidget *editingWidget;
    QVBoxLayout *mainLayout;
    QVBoxLayout *btnsLayout;
    QStringListModel *model;
 
    bool checkAtEntering;
    KEditListBox::Buttons buttons;
 
    void init(bool check = false, KEditListBox::Buttons buttons = KEditListBox::All,
              QWidget *representationWidget = nullptr);
    void setEditor(KLineEdit *lineEdit, QWidget *representationWidget = nullptr);
    void updateButtonState();
    QModelIndex selectedIndex();
 
private:
    KEditListBox *q;
};
 
void KEditListBoxPrivate::init(bool check, KEditListBox::Buttons newButtons,
                               QWidget *representationWidget)
{
    checkAtEntering = check;
 
    servNewButton = servRemoveButton = servUpButton = servDownButton = nullptr;
    q->setSizePolicy(QSizePolicy(QSizePolicy::MinimumExpanding,
                                 QSizePolicy::Preferred));
 
    mainLayout = new QVBoxLayout(q);
 
    QHBoxLayout *subLayout = new QHBoxLayout;
    btnsLayout = new QVBoxLayout;
    btnsLayout->addStretch();
 
    model = new QStringListModel();
    listView = new QListView(q);
    listView->setModel(model);
 
    subLayout->addWidget(listView);
    subLayout->addLayout(btnsLayout);
 
    mainLayout->insertLayout(1, subLayout);
 
    setEditor(lineEdit, representationWidget);
 
    buttons = KEditListBox::Buttons();
    q->setButtons(newButtons);
 
    q->connect(listView->selectionModel(), SIGNAL(selectionChanged(QItemSelection,QItemSelection)),
               SLOT(slotSelectionChanged(QItemSelection,QItemSelection)));
}
 
void KEditListBoxPrivate::setEditor(KLineEdit *newLineEdit, QWidget *representationWidget)
{
    if (editingWidget != lineEdit &&
            editingWidget != representationWidget) {
        delete editingWidget;
    }
    if (lineEdit != newLineEdit) {
        delete lineEdit;
    }
    lineEdit = newLineEdit ? newLineEdit : new KLineEdit(q);
    editingWidget = representationWidget ?
                    representationWidget : lineEdit;
 
    if (representationWidget) {
        representationWidget->setParent(q);
    }
 
    mainLayout->insertWidget(0, editingWidget);
 
    lineEdit->setTrapReturnKey(true);
    lineEdit->installEventFilter(q);
 
    q->connect(lineEdit, SIGNAL(textChanged(QString)), SLOT(typedSomething(QString)));
    q->connect(lineEdit, SIGNAL(returnPressed()), SLOT(addItem()));
 
    // maybe supplied lineedit has some text already
    q->typedSomething(lineEdit->text());
 
    // fix tab ordering
    q->setTabOrder(editingWidget, listView);
    QWidget *w = listView;
    if (servNewButton) {
        q->setTabOrder(w, servNewButton);
        w = servNewButton;
    }
    if (servRemoveButton) {
        q->setTabOrder(w, servRemoveButton);
        w = servRemoveButton;
    }
    if (servUpButton) {
        q->setTabOrder(w, servUpButton);
        w = servUpButton;
    }
    if (servDownButton) {
        q->setTabOrder(w, servDownButton);
        w = servDownButton;
    }
}
 
void KEditListBoxPrivate::updateButtonState()
{
    QModelIndex index = selectedIndex();
    if (servUpButton) {
        servUpButton->setEnabled(index.isValid());
    }
    if (servDownButton) {
        servDownButton->setEnabled(index.isValid());
    }
    if (servRemoveButton) {
        servRemoveButton->setEnabled(index.isValid());
    }
}
 
QModelIndex KEditListBoxPrivate::selectedIndex()
{
    QItemSelectionModel *selection = listView->selectionModel();
    const QModelIndexList selectedIndexes = selection->selectedIndexes();
    if (!selectedIndexes.isEmpty() && selectedIndexes[0].isValid()) {
        return selectedIndexes[0];
    } else {
        return QModelIndex();
    }
}
 
class Q_DECL_HIDDEN KEditListBox::CustomEditorPrivate
{
public:
    CustomEditorPrivate(KEditListBox::CustomEditor *q):
        q(q),
        representationWidget(nullptr),
        lineEdit(nullptr) {}
 
    KEditListBox::CustomEditor *q;
    QWidget *representationWidget;
    KLineEdit *lineEdit;
};
 
KEditListBox::CustomEditor::CustomEditor()
    : d(new CustomEditorPrivate(this))
{
}
 
KEditListBox::CustomEditor::CustomEditor(QWidget *repWidget, KLineEdit *edit)
    : d(new CustomEditorPrivate(this))
{
    d->representationWidget = repWidget;
    d->lineEdit = edit;
}
 
KEditListBox::CustomEditor::CustomEditor(KComboBox *combo)
    : d(new CustomEditorPrivate(this))
{
    d->representationWidget = combo;
    d->lineEdit = qobject_cast<KLineEdit *>(combo->lineEdit());
    Q_ASSERT(d->lineEdit);
}
 
KEditListBox::CustomEditor::~CustomEditor()
{
    delete d;
}
 
void KEditListBox::CustomEditor::setRepresentationWidget(QWidget *repWidget)
{
    d->representationWidget = repWidget;
}
 
void KEditListBox::CustomEditor::setLineEdit(KLineEdit *edit)
{
    d->lineEdit = edit;
}
 
QWidget *KEditListBox::CustomEditor::representationWidget() const
{
    return d->representationWidget;
}
 
KLineEdit *KEditListBox::CustomEditor::lineEdit() const
{
    return d->lineEdit;
}
 
KEditListBox::KEditListBox(QWidget *parent)
    : QGroupBox(parent), d(new KEditListBoxPrivate(this))
{
    d->init();
}
 
KEditListBox::KEditListBox(const QString &title, QWidget *parent)
    : QGroupBox(title, parent), d(new KEditListBoxPrivate(this))
{
    d->init();
}
 
KEditListBox::KEditListBox(QWidget *parent, const char *name,
                           bool checkAtEntering, Buttons buttons)
    : QGroupBox(parent), d(new KEditListBoxPrivate(this))
{
    setObjectName(name);
    d->init(checkAtEntering, buttons);
}
 
KEditListBox::KEditListBox(const QString &title, QWidget *parent,
                           const char *name, bool checkAtEntering, Buttons buttons)
    : QGroupBox(title, parent), d(new KEditListBoxPrivate(this))
{
    setObjectName(name);
    d->init(checkAtEntering, buttons);
}
 
KEditListBox::KEditListBox(const QString &title, const CustomEditor &custom,
                           QWidget *parent, const char *name,
                           bool checkAtEntering, Buttons buttons)
    : QGroupBox(title, parent), d(new KEditListBoxPrivate(this))
{
    setObjectName(name);
    d->lineEdit = custom.lineEdit();
    d->init(checkAtEntering, buttons, custom.representationWidget());
}
 
KEditListBox::~KEditListBox()
{
    delete d;
}
 
void KEditListBox::setCustomEditor(const CustomEditor &editor)
{
    d->setEditor(editor.lineEdit(), editor.representationWidget());
}
 
QListView *KEditListBox::listView() const
{
    return d->listView;
}
 
KLineEdit *KEditListBox::lineEdit() const
{
    return d->lineEdit;
}
 
QPushButton *KEditListBox::addButton() const
{
    return d->servNewButton;
}
 
QPushButton *KEditListBox::removeButton() const
{
    return d->servRemoveButton;
}
 
QPushButton *KEditListBox::upButton() const
{
    return d->servUpButton;
}
 
QPushButton *KEditListBox::downButton() const
{
    return d->servDownButton;
}
 
int KEditListBox::count() const
{
    return int(d->model->rowCount());
}
 
void KEditListBox::setButtons(Buttons buttons)
{
    if (d->buttons == buttons) {
        return;
    }
 
    if ((buttons & Add) && !d->servNewButton) {
        d->servNewButton = new QPushButton(QIcon::fromTheme("list-add"), i18n("&Add"), this);
        d->servNewButton->setEnabled(false);
        d->servNewButton->show();
        connect(d->servNewButton, SIGNAL(clicked()), SLOT(addItem()));
 
        d->btnsLayout->insertWidget(0, d->servNewButton);
    } else if ((buttons & Add) == 0 && d->servNewButton) {
        delete d->servNewButton;
        d->servNewButton = nullptr;
    }
 
    if ((buttons & Remove) && !d->servRemoveButton) {
        d->servRemoveButton = new QPushButton(QIcon::fromTheme("list-remove"), i18n("&Remove"), this);
        d->servRemoveButton->setEnabled(false);
        d->servRemoveButton->show();
        connect(d->servRemoveButton, SIGNAL(clicked()), SLOT(removeItem()));
 
        d->btnsLayout->insertWidget(1, d->servRemoveButton);
    } else if ((buttons & Remove) == 0 && d->servRemoveButton) {
        delete d->servRemoveButton;
        d->servRemoveButton = nullptr;
    }
 
    if ((buttons & UpDown) && !d->servUpButton) {
        d->servUpButton = new QPushButton(QIcon::fromTheme("arrow-up"), i18n("Move &Up"), this);
        d->servUpButton->setEnabled(false);
        d->servUpButton->show();
        connect(d->servUpButton, SIGNAL(clicked()), SLOT(moveItemUp()));
 
        d->servDownButton = new QPushButton(QIcon::fromTheme("arrow-down"), i18n("Move &Down"), this);
        d->servDownButton->setEnabled(false);
        d->servDownButton->show();
        connect(d->servDownButton, SIGNAL(clicked()), SLOT(moveItemDown()));
 
        d->btnsLayout->insertWidget(2, d->servUpButton);
        d->btnsLayout->insertWidget(3, d->servDownButton);
    } else if ((buttons & UpDown) == 0 && d->servUpButton) {
        delete d->servUpButton; d->servUpButton = nullptr;
        delete d->servDownButton; d->servDownButton = nullptr;
    }
 
    d->buttons = buttons;
}
 
void KEditListBox::setCheckAtEntering(bool check)
{
    d->checkAtEntering = check;
}
 
bool KEditListBox::checkAtEntering()
{
    return d->checkAtEntering;
}
 
void KEditListBox::typedSomething(const QString &text)
{
    if (currentItem() >= 0) {
        if (currentText() != d->lineEdit->text()) {
            // IMHO changeItem() shouldn't do anything with the value
            // of currentItem() ... like changing it or emitting signals ...
            // but TT disagree with me on this one (it's been that way since ages ... grrr)
            bool block = d->listView->signalsBlocked();
            d->listView->blockSignals(true);
            QModelIndex currentIndex = d->selectedIndex();
            if (currentIndex.isValid()) {
                d->model->setData(currentIndex, text);
            }
            d->listView->blockSignals(block);
            emit changed();
        }
    }
 
    if (!d->servNewButton) {
        return;
    }
 
    if (!d->lineEdit->hasAcceptableInput()) {
        d->servNewButton->setEnabled(false);
        return;
    }
 
    if (!d->checkAtEntering) {
        d->servNewButton->setEnabled(!text.isEmpty());
    } else {
        if (text.isEmpty()) {
            d->servNewButton->setEnabled(false);
        } else {
            QStringList list = d->model->stringList();
            bool enable = !list.contains(text, Qt::CaseSensitive);
            d->servNewButton->setEnabled(enable);
        }
    }
}
 
void KEditListBox::moveItemUp()
{
    if (!d->listView->isEnabled()) {
        KNotification::beep();
        return;
    }
 
    QModelIndex index = d->selectedIndex();
    if (index.isValid()) {
        if (index.row() == 0) {
            KNotification::beep();
            return;
        }
 
        QModelIndex aboveIndex = d->model->index(index.row() - 1, index.column());
 
        QString tmp = d->model->data(aboveIndex, Qt::DisplayRole).toString();
        d->model->setData(aboveIndex, d->model->data(index, Qt::DisplayRole));
        d->model->setData(index, tmp);
 
        d->listView->selectionModel()->select(index, QItemSelectionModel::Deselect);
        d->listView->selectionModel()->select(aboveIndex, QItemSelectionModel::Select);
    }
 
    emit changed();
}
 
void KEditListBox::moveItemDown()
{
    if (!d->listView->isEnabled()) {
        KNotification::beep();
        return;
    }
 
    QModelIndex index = d->selectedIndex();
    if (index.isValid()) {
        if (index.row() == d->model->rowCount() - 1) {
            KNotification::beep();
            return;
        }
 
        QModelIndex belowIndex = d->model->index(index.row() + 1, index.column());
 
        QString tmp = d->model->data(belowIndex, Qt::DisplayRole).toString();
        d->model->setData(belowIndex, d->model->data(index, Qt::DisplayRole));
        d->model->setData(index, tmp);
 
        d->listView->selectionModel()->select(index, QItemSelectionModel::Deselect);
        d->listView->selectionModel()->select(belowIndex, QItemSelectionModel::Select);
    }
 
    emit changed();
}
 
void KEditListBox::addItem()
{
    // when checkAtEntering is true, the add-button is disabled, but this
    // slot can still be called through Key_Return/Key_Enter. So we guard
    // against this.
    if (!d->servNewButton || !d->servNewButton->isEnabled()) {
        return;
    }
 
    QModelIndex currentIndex = d->selectedIndex();
 
    const QString &currentTextLE = d->lineEdit->text();
    bool alreadyInList(false);
    //if we didn't check for dupes at the inserting we have to do it now
    if (!d->checkAtEntering) {
        // first check current item instead of dumb iterating the entire list
        if (currentIndex.isValid()) {
            if (d->model->data(currentIndex, Qt::DisplayRole).toString() == currentTextLE) {
                alreadyInList = true;
            }
        } else {
            alreadyInList = d->model->stringList().contains(currentTextLE, Qt::CaseSensitive);
        }
    }
    if (d->servNewButton) {
        d->servNewButton->setEnabled(false);
    }
 
    bool block = d->lineEdit->signalsBlocked();
    d->lineEdit->blockSignals(true);
    d->lineEdit->clear();
    d->lineEdit->blockSignals(block);
 
    d->listView->selectionModel()->setCurrentIndex(currentIndex, QItemSelectionModel::Deselect);
 
    if (!alreadyInList) {
        block = d->listView->signalsBlocked();
 
        if (currentIndex.isValid()) {
            d->model->setData(currentIndex, currentTextLE);
        } else {
            QStringList lst;
            lst << currentTextLE;
            lst << d->model->stringList();
            d->model->setStringList(lst);
        }
        emit changed();
        emit added(currentTextLE);   // TODO: pass the index too
    }
 
    d->updateButtonState();
}
 
int KEditListBox::currentItem() const
{
    QModelIndex selectedIndex = d->selectedIndex();
    if (selectedIndex.isValid()) {
        return selectedIndex.row();
    } else {
        return -1;
    }
}
 
void KEditListBox::removeItem()
{
    QModelIndex currentIndex = d->selectedIndex();
    if (!currentIndex.isValid()) {
        return;
    }
 
    if (currentIndex.row() >= 0) {
        QString removedText = d->model->data(currentIndex, Qt::DisplayRole).toString();
 
        d->model->removeRows(currentIndex.row(), 1);
 
        d->listView->selectionModel()->clear();
 
        emit changed();
 
        emit removed(removedText);
    }
 
    d->updateButtonState();
}
 
void KEditListBox::enableMoveButtons(const QModelIndex &newIndex, const QModelIndex &)
{
    int index = newIndex.row();
 
    // Update the lineEdit when we select a different line.
    if (currentText() != d->lineEdit->text()) {
        d->lineEdit->setText(currentText());
    }
 
    bool moveEnabled = d->servUpButton && d->servDownButton;
 
    if (moveEnabled) {
        if (d->model->rowCount() <= 1) {
            d->servUpButton->setEnabled(false);
            d->servDownButton->setEnabled(false);
        } else if (index == (d->model->rowCount() - 1)) {
            d->servUpButton->setEnabled(true);
            d->servDownButton->setEnabled(false);
        } else if (index == 0) {
            d->servUpButton->setEnabled(false);
            d->servDownButton->setEnabled(true);
        } else {
            d->servUpButton->setEnabled(true);
            d->servDownButton->setEnabled(true);
        }
    }
 
    if (d->servRemoveButton) {
        d->servRemoveButton->setEnabled(true);
    }
}
 
void KEditListBox::clear()
{
    d->lineEdit->clear();
    d->model->setStringList(QStringList());
    emit changed();
}
 
void KEditListBox::insertStringList(const QStringList &list, int index)
{
    QStringList content = d->model->stringList();
    if (index < 0) {
        content += list;
    } else
        for (int i = 0, j = index; i < list.count(); ++i, ++j) {
            content.insert(j, list[ i ]);
        }
 
    d->model->setStringList(content);
}
 
void KEditListBox::insertItem(const QString &text, int index)
{
    QStringList list = d->model->stringList();
 
    if (index < 0) {
        list.append(text);
    } else {
        list.insert(index, text);
    }
 
    d->model->setStringList(list);
}
 
QString KEditListBox::text(int index) const
{
    const QStringList list = d->model->stringList();
 
    return list[ index ];
}
 
QString KEditListBox::currentText() const
{
    QModelIndex index = d->selectedIndex();
    if (!index.isValid()) {
        return QString();
    } else {
        return text(index.row());
    }
}
 
QStringList KEditListBox::items() const
{
    return d->model->stringList();
}
 
void KEditListBox::setItems(const QStringList &items)
{
    d->model->setStringList(items);
}
 
KEditListBox::Buttons KEditListBox::buttons() const
{
    return d->buttons;
}
 
void KEditListBox::slotSelectionChanged(const QItemSelection &, const QItemSelection &)
{
    d->updateButtonState();
    QModelIndex index = d->selectedIndex();
    enableMoveButtons(index,  QModelIndex());
    if (index.isValid()) {
        d->lineEdit->setFocus(Qt::OtherFocusReason);
    }
}
 
bool KEditListBox::eventFilter(QObject *o, QEvent *e)
{
    if (o == d->lineEdit && e->type() == QEvent::KeyPress) {
        QKeyEvent *keyEvent = (QKeyEvent *)e;
        if (keyEvent->key() == Qt::Key_Down ||
                keyEvent->key() == Qt::Key_Up) {
            return ((QObject *)d->listView)->event(e);
        }
    }
 
    return false;
}
 
#include "moc_keditlistbox.cpp"