kcombobox.h

/* This file is part of the KDE libraries

   Copyright (c) 2000,2001 Dawit Alemayehu <[email protected]>
   Copyright (c) 2000,2001 Carsten Pfeiffer <[email protected]>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License (LGPL) 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
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser 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 KCOMBOBOX_H
#define KCOMBOBOX_H

#include <kcompletion.h>

#include <kcompletionbase.h>
#include <kcompletion_export.h>

#include <QComboBox>

class KCompletionBox;
class KComboBoxPrivate;

class QLineEdit;
class QMenu;

class KCOMPLETION_EXPORT KComboBox : public QComboBox, public KCompletionBase //krazy:exclude=qclasses
{
    Q_OBJECT
    Q_PROPERTY(bool autoCompletion READ autoCompletion WRITE setAutoCompletion)
#if KCOMPLETION_BUILD_DEPRECATED_SINCE(5, 0)
    Q_PROPERTY(bool urlDropsEnabled READ urlDropsEnabled WRITE setUrlDropsEnabled)
#endif
    Q_PROPERTY(bool trapReturnKey READ trapReturnKey WRITE setTrapReturnKey)
    Q_DECLARE_PRIVATE(KComboBox)

public:

    explicit KComboBox(QWidget *parent = nullptr);

    explicit KComboBox(bool rw, QWidget *parent = nullptr);

    ~KComboBox() override;

#if KCOMPLETION_ENABLE_DEPRECATED_SINCE(4, 5)

    KCOMPLETION_DEPRECATED_VERSION(4, 5, "Use KComboBox::insertUrl(int, const QUrl&)")
    void insertURL(const QUrl &url, int index = -1)
    {
        insertUrl(index < 0 ? count() : index, url);
    }
    KCOMPLETION_DEPRECATED_VERSION(4, 5, "Use KComboBox::insertUrl(int, const QIcon&, const QUrl&)")
    void insertURL(const QPixmap &pixmap, const QUrl &url, int index = -1)
    {
        insertUrl(index < 0 ? count() : index, QIcon(pixmap), url);
    }
    KCOMPLETION_DEPRECATED_VERSION(4, 5, "Use KComboBox::changeUrl(int, const QUrl&)")
    void changeURL(const QUrl &url, int index)
    {
        changeUrl(index, url);
    }
    KCOMPLETION_DEPRECATED_VERSION(4, 5, "Use KComboBox::changeUrl(int, const QIcon&, const QUrl&)")
    void changeURL(const QPixmap &pixmap, const QUrl &url, int index)
    {
        changeUrl(index, QIcon(pixmap), url);
    }
#endif

    void setEditUrl(const QUrl &url);

    void addUrl(const QUrl &url);

    void addUrl(const QIcon &icon,  const QUrl &url);

    void insertUrl(int index, const QUrl &url);

    void insertUrl(int index, const QIcon &icon, const QUrl &url);

    void changeUrl(int index, const QUrl &url);

    void changeUrl(int index, const QIcon &icon, const QUrl &url);

    int cursorPosition() const;

    virtual void setAutoCompletion(bool autocomplete);

    bool autoCompletion() const;

#if KCOMPLETION_BUILD_DEPRECATED_SINCE(4, 5)

    KCOMPLETION_DEPRECATED_VERSION(4, 5, "Use QWidget::setContextMenuPolicy(...)")
    virtual void setContextMenuEnabled(bool showMenu);
#endif

#if KCOMPLETION_ENABLE_DEPRECATED_SINCE(5, 0)

    KCOMPLETION_DEPRECATED_VERSION(5, 0, "Use KComboBox::lineEdit()->installEventFilter(...) with a LineEditUrlDropEventFilter")
    void setUrlDropsEnabled(bool enable);
#endif

    bool urlDropsEnabled() const;

    bool contains(const QString &text) const;

    void setTrapReturnKey(bool trap);

    bool trapReturnKey() const;

    KCompletionBox *completionBox(bool create = true);

    virtual void setLineEdit(QLineEdit *);

    void setEditable(bool editable);

Q_SIGNALS:
    void returnPressed();

    void returnPressed(const QString &);

    void completion(const QString &);

    void substringCompletion(const QString &);

    void textRotation(KCompletionBase::KeyBindingType);

    void completionModeChanged(KCompletion::CompletionMode);

    void aboutToShowContextMenu(QMenu *contextMenu);

public Q_SLOTS:

    void rotateText(KCompletionBase::KeyBindingType type);

    void setCompletedText(const QString &) override;

    void setCompletedItems(const QStringList &items, bool autosubject = true) override;

    void setCurrentItem(const QString &item, bool insert = false, int index = -1);

protected Q_SLOTS:

    virtual void makeCompletion(const QString &);

protected:
    virtual void setCompletedText(const QString &text, bool marked);

    // TODO KF6: make public like in base classes, so consumers do not need to cast to base classes
    // when they have a KComboBox (or subclasses) object and want to access this property
    QSize minimumSizeHint() const override;

private:
    const QScopedPointer<KComboBoxPrivate> d_ptr;
    Q_PRIVATE_SLOT(d_func(), void _k_lineEditDeleted())
};

#endif