-/***************************************************************************
- * Copyright (C) 2012 by Peter Penz <peter.penz19@gmail.com> *
- * *
- * This program is free software; you can redistribute it and/or modify *
- * it under the terms of the GNU General Public License as published by *
- * the Free Software Foundation; either version 2 of the License, or *
- * (at your option) any later version. *
- * *
- * This program 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 General Public License for more details. *
- * *
- * You should have received a copy of the GNU General Public License *
- * along with this program; if not, write to the *
- * Free Software Foundation, Inc., *
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
- ***************************************************************************/
+/*
+ * SPDX-FileCopyrightText: 2012 Peter Penz <peter.penz19@gmail.com>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
#ifndef KITEMLISTROLEEDITOR_H
#define KITEMLISTROLEEDITOR_H
#include <KTextEdit>
+enum EditResultDirection {
+ EditDone,
+ EditNext,
+ EditPrevious,
+};
+Q_DECLARE_METATYPE(EditResultDirection)
+
+struct EditResult {
+ QString newName;
+ EditResultDirection direction;
+};
+Q_DECLARE_METATYPE(EditResult)
+
/**
* @brief Editor for renaming roles of a KItemListWidget.
*
* Provides signals when the editing got cancelled (e.g. by
* pressing Escape or when losing the focus) or when the editing
- * got finished (e.g. by pressing Enter or Return).
+ * got finished (e.g. by pressing Enter, Tab or Return).
*
* The size automatically gets increased if the text does not fit.
*/
Q_OBJECT
public:
- explicit KItemListRoleEditor(QWidget* parent);
+ explicit KItemListRoleEditor(QWidget *parent);
~KItemListRoleEditor() override;
- void setRole(const QByteArray& role);
+ void setRole(const QByteArray &role);
QByteArray role() const;
- bool eventFilter(QObject* watched, QEvent* event) override;
-
-signals:
- void roleEditingFinished(const QByteArray& role, const QVariant& value);
- void roleEditingCanceled(const QByteArray& role, const QVariant& value);
+ void setAllowUpDownKeyChainEdit(bool allowChainEdit);
+ bool eventFilter(QObject *watched, QEvent *event) override;
-protected:
- bool event(QEvent* event) override;
- void keyPressEvent(QKeyEvent* event) override;
+Q_SIGNALS:
+ void roleEditingFinished(const QByteArray &role, const QVariant &value);
+ void roleEditingCanceled(const QByteArray &role, const QVariant &value);
-private slots:
+public Q_SLOTS:
/**
* Increases the size of the editor in case if there is not
* enough room for the text.
*/
void autoAdjustSize();
+protected:
+ bool event(QEvent *event) override;
+ void keyPressEvent(QKeyEvent *event) override;
+
private:
/**
* Emits the signal roleEditingFinished if m_blockFinishedSignal
* is false.
*/
- void emitRoleEditingFinished();
+ void emitRoleEditingFinished(EditResultDirection direction = EditDone);
private:
QByteArray m_role;
bool m_blockFinishedSignal;
+ bool m_allowUpDownKeyChainEdit;
};
#endif