keditlistbox.h

/* This file is part of the KDE libraries
    Copyright (C) 2000 David Faure <[email protected]>, Alexander Neundorf <[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.
*/
 
#ifndef KEDITLISTBOX_H
#define KEDITLISTBOX_H
 
#include <kdelibs4support_export.h>
 
#include <QGroupBox>
#include <QStringListModel>
 
class KLineEdit;
class KComboBox;
class QListView;
class QPushButton;
class QItemSelection;
 
class KEditListBoxPrivate;
/**
 * @brief An editable listbox
 *
 * @deprecated since 5.0 in favor of KEditListWidget embedded in a QGroupBox.
 */
class KDELIBS4SUPPORT_DEPRECATED_EXPORT KEditListBox : public QGroupBox
{
    Q_OBJECT
 
    Q_FLAGS(Buttons)
    Q_PROPERTY(Buttons buttons READ buttons WRITE setButtons)
    Q_PROPERTY(QStringList items READ items WRITE setItems NOTIFY changed USER true)
 
public:
    class CustomEditorPrivate;
 
    /**
     * Custom editor class
     **/
    class KDELIBS4SUPPORT_DEPRECATED_EXPORT CustomEditor
    {
    public:
        CustomEditor();
        CustomEditor(QWidget *repWidget, KLineEdit *edit);
        CustomEditor(KComboBox *combo);
        virtual ~CustomEditor();
 
        void setRepresentationWidget(QWidget *repWidget);
        void setLineEdit(KLineEdit *edit);
 
        virtual QWidget *representationWidget() const;
        virtual KLineEdit *lineEdit() const;
 
    private:
        friend class CustomEditorPrivate;
        CustomEditorPrivate *const d;
 
        Q_DISABLE_COPY(CustomEditor)
    };
 
public:
 
    /**
     * Enumeration of the buttons, the listbox offers. Specify them in the
     * constructor in the buttons parameter, or in setButtons.
     */
    enum Button {
        Add = 0x0001,
        Remove = 0x0002,
        UpDown = 0x0004,
        All = Add | Remove | UpDown
    };
 
    Q_DECLARE_FLAGS(Buttons, Button)
 
    /**
     * Create an editable listbox.
     */
    KDELIBS4SUPPORT_DEPRECATED explicit KEditListBox(QWidget *parent = nullptr);
 
    /**
     * Create an editable listbox.
     *
     * The same as the other constructor, additionally it takes
     * @p title, which will be the title of the groupbox around the listbox.
     */
    KDELIBS4SUPPORT_DEPRECATED explicit KEditListBox(const QString &title, QWidget *parent = nullptr);
 
// ### KDE5: remove name arguments and simplify (merge?!) constructors
 
    /**
     * Create an editable listbox.
     *
     * \deprecated
     *
     * If @p checkAtEntering is true, after every character you type
     * in the line edit KEditListBox will enable or disable
     * the Add-button, depending whether the current content of the
     * line edit is already in the listbox. Maybe this can become a
     * performance hit with large lists on slow machines.
     * If @p checkAtEntering is false,
     * it will be checked if you press the Add-button. It is not
     * possible to enter items twice into the listbox.
     */
    KDELIBS4SUPPORT_DEPRECATED explicit KEditListBox(QWidget *parent, const char *name,
            bool checkAtEntering = false, Buttons buttons = All);
    /**
     * Create an editable listbox.
     *
     * \deprecated
     *
     * The same as the other constructor, additionally it takes
     * @p title, which will be the title of the frame around the listbox.
     */
    KDELIBS4SUPPORT_DEPRECATED explicit KEditListBox(const QString &title, QWidget *parent,
            const char *name, bool checkAtEntering = false,
            Buttons buttons = All);
 
    /**
     * Another constructor, which allows to use a custom editing widget
     * instead of the standard KLineEdit widget. E.g. you can use a
     * KUrlRequester or a KComboBox as input widget. The custom
     * editor must consist of a lineedit and optionally another widget that
     * is used as representation. A KComboBox or a KUrlRequester have a
     * KLineEdit as child-widget for example, so the KComboBox is used as
     * the representation widget.
     *
     * @see KUrlRequester::customEditor(), setCustomEditor
     */
    KEditListBox(const QString &title,
                 const CustomEditor &customEditor,
                 QWidget *parent = nullptr, const char *name = nullptr,
                 bool checkAtEntering = false, Buttons buttons = All);
 
    ~KEditListBox() override;
 
    /**
     * Return a pointer to the embedded QListView.
     */
    QListView *listView() const;
    /**
     * Return a pointer to the embedded KLineEdit.
     */
    KLineEdit *lineEdit() const;
    /**
     * Return a pointer to the Add button
     */
    QPushButton *addButton() const;
    /**
     * Return a pointer to the Remove button
     */
    QPushButton *removeButton() const;
    /**
     * Return a pointer to the Up button
     */
    QPushButton *upButton() const;
    /**
     * Return a pointer to the Down button
     */
    QPushButton *downButton() const;
 
    /**
     * See Q3ListBox::count()
     */
    int count() const;
    /**
     * See Q3ListBox::insertStringList()
     */
    void insertStringList(const QStringList &list, int index = -1);
    /**
     * See Q3ListBox::insertItem()
     */
    void insertItem(const QString &text, int index = -1);
    /**
     * Clears both the listbox and the line edit.
     */
    void clear();
    /**
     * See Q3ListBox::text()
     */
    QString text(int index) const;
    /**
     * See Q3ListBox::currentItem()
     */
    int currentItem() const;
    /**
     * See Q3ListBox::currentText()
     */
    QString currentText() const;
 
    /**
     * @returns a stringlist of all items in the listbox
     */
    QStringList items() const;
 
    /**
     * Clears the listbox and sets the contents to @p items
     */
    void setItems(const QStringList &items);
 
    /**
     * Returns which buttons are visible
     */
    Buttons buttons() const;
 
    /**
     * Specifies which buttons should be visible
     */
    void setButtons(Buttons buttons);
 
    /**
     * If @p check is true, after every character you type
     * in the line edit KEditListBox will enable or disable
     * the Add-button, depending whether the current content of the
     * line edit is already in the listbox. Maybe this can become a
     * performance hit with large lists on slow machines.
     * If @p check is false,
     * it will be checked if you press the Add-button. It is not
     * possible to enter items twice into the listbox.
     * Default is false.
     */
    void setCheckAtEntering(bool check);
 
    /**
     * Returns true if check at entering is enabled.
     */
    bool checkAtEntering();
 
    /**
     * Allows to use a custom editing widget
     * instead of the standard KLineEdit widget. E.g. you can use a
     * KUrlRequester or a KComboBox as input widget. The custom
     * editor must consist of a lineedit and optionally another widget that
     * is used as representation. A KComboBox or a KUrlRequester have a
     * KLineEdit as child-widget for example, so the KComboBox is used as
     * the representation widget.
     *
     * @since 4.1
     */
    void setCustomEditor(const CustomEditor &editor);
 
    /**
     * Reimplented for interal reasons. The API is not affected.
     */
    bool eventFilter(QObject *o, QEvent *e) override;
 
Q_SIGNALS:
    void changed();
 
    /**
     * This signal is emitted when the user adds a new string to the list,
     * the parameter is the added string.
     */
    void added(const QString &text);
 
    /**
     * This signal is emitted when the user removes a string from the list,
     * the parameter is the removed string.
     */
    void removed(const QString &text);
 
protected Q_SLOTS: // KDE5: make private?
    void moveItemUp();
    void moveItemDown();
    void addItem();
    void removeItem();
    void enableMoveButtons(const QModelIndex &, const QModelIndex &);
    void typedSomething(const QString &text);
 
private Q_SLOTS:
    void slotSelectionChanged(const QItemSelection &selected, const QItemSelection &deselected);
 
private:
    friend class KEditListBoxPrivate;
    KEditListBoxPrivate *const d;
 
    Q_DISABLE_COPY(KEditListBox)
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS(KEditListBox::Buttons)
 
#endif