klineedit.h

/*  This file is part of the KDE libraries

    This class was originally inspired by Torben Weis'
    fileentry.cpp for KFM II.

    Copyright (C) 1997 Sven Radej <[email protected]>
    Copyright (c) 1999 Patrick Ward <[email protected]>
    Copyright (c) 1999 Preston Brown <[email protected]>

    Completely re-designed:
    Copyright (c) 2000,2001 Dawit Alemayehu <[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 KLINEEDIT_H
#define KLINEEDIT_H

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

#include <QLineEdit>

class QAction;
class QMenu;
class KCompletionBox;
class QUrl;
class KLineEditPrivate;

class KCOMPLETION_EXPORT KLineEdit : public QLineEdit, public KCompletionBase //krazy:exclude=qclasses
{
    friend class KComboBox;
    friend class KLineEditStyle;

    Q_OBJECT
    Q_DECLARE_PRIVATE(KLineEdit)
#if KCOMPLETION_BUILD_DEPRECATED_SINCE(4, 5)
    Q_PROPERTY(bool contextMenuEnabled READ isContextMenuEnabled WRITE setContextMenuEnabled)
#endif
#if KCOMPLETION_BUILD_DEPRECATED_SINCE(5, 0)
    Q_PROPERTY(bool urlDropsEnabled READ urlDropsEnabled WRITE setUrlDropsEnabled)
#endif
    Q_PROPERTY(bool trapEnterKeyEvent READ trapReturnKey WRITE setTrapReturnKey)
    Q_PROPERTY(bool squeezedTextEnabled READ isSqueezedTextEnabled WRITE setSqueezedTextEnabled)
#if KCOMPLETION_BUILD_DEPRECATED_SINCE(5, 0)
    Q_PROPERTY(QString clickMessage READ clickMessage WRITE setClickMessage)
#endif
#if KCOMPLETION_BUILD_DEPRECATED_SINCE(5, 46)
    Q_PROPERTY(bool showClearButton READ isClearButtonShown WRITE setClearButtonShown)
#endif
    Q_PROPERTY(bool passwordMode READ passwordMode WRITE setPasswordMode)

public:

    explicit KLineEdit(const QString &string, QWidget *parent = nullptr);

    explicit KLineEdit(QWidget *parent = nullptr);

    ~KLineEdit() override;

    void setUrl(const QUrl &url);

    void setCompletionMode(KCompletion::CompletionMode mode) override;

    void setCompletionModeDisabled(KCompletion::CompletionMode mode, bool disable = true);

#if KCOMPLETION_BUILD_DEPRECATED_SINCE(4, 5)

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

#if KCOMPLETION_ENABLE_DEPRECATED_SINCE(4, 5)

    KCOMPLETION_DEPRECATED_VERSION(4, 5, "Use QWidget::contextMenuPolicy()")
    bool isContextMenuEnabled() const;
#endif

    void setUrlDropsEnabled(bool enable);  // KF6: remove it and don't create LineEditUrlDropEventFilter by default.

    bool urlDropsEnabled() const;

    void setTrapReturnKey(bool trap);

    bool trapReturnKey() const;

    virtual KCompletionBox *completionBox(bool create = true);

    void setCompletionObject(KCompletion *, bool handle = true) override;

    virtual void copy() const;

    void setSqueezedTextEnabled(bool enable);

    bool isSqueezedTextEnabled() const;

    QString originalText() const;

    QString userText() const;

    void setCompletionBox(KCompletionBox *box);

#if KCOMPLETION_ENABLE_DEPRECATED_SINCE(5, 0)

    KCOMPLETION_DEPRECATED_VERSION(5, 0, "Use QLineEdit::setPlaceholderText(const QString&)")
    void setClickMessage(const QString &msg);
#endif

#if KCOMPLETION_ENABLE_DEPRECATED_SINCE(5, 0)

    KCOMPLETION_DEPRECATED_VERSION(5, 0, "Use QLineEdit::placeholderText()")
    QString clickMessage() const;
#endif

#if KCOMPLETION_ENABLE_DEPRECATED_SINCE(5, 46)

    KCOMPLETION_DEPRECATED_VERSION(5, 46, "Use QLineEdit::setClearButtonEnabled(bool)")
    void setClearButtonShown(bool show);
#endif

#if KCOMPLETION_ENABLE_DEPRECATED_SINCE(5, 46)

    KCOMPLETION_DEPRECATED_VERSION(5, 46, "Use QLineEdit::isClearButtonEnabled()")
    bool isClearButtonShown() const;
#endif

    QSize clearButtonUsedSize() const;

    void doCompletion(const QString &text);

Q_SIGNALS:

    void completionBoxActivated(const QString &);

    void returnPressed(const QString &);

    void completion(const QString &);

    void substringCompletion(const QString &);

#if KCOMPLETION_ENABLE_DEPRECATED_SINCE(4, 5)

    KCOMPLETION_DEPRECATED_VERSION(4, 5, "Use QLineEdit::textEdited(const QString&)")
    QT_MOC_COMPAT void userTextChanged(const QString &);
#endif

    void textRotation(KCompletionBase::KeyBindingType);

    void completionModeChanged(KCompletion::CompletionMode);

    void aboutToShowContextMenu(QMenu *contextMenu);

    void clearButtonClicked();

public Q_SLOTS:

    virtual void setReadOnly(bool);

    void rotateText(KCompletionBase::KeyBindingType type);

    void setCompletedText(const QString &) override;

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

    void setSqueezedText(const QString &text);

    virtual void setText(const QString &);

    void setPasswordMode(bool passwordMode = true);

    bool passwordMode() const;

protected Q_SLOTS:

    virtual void makeCompletion(const QString &);

    void userCancelled(const QString &cancelText);

protected:

    bool event(QEvent *) override;

    void resizeEvent(QResizeEvent *) override;

    void keyPressEvent(QKeyEvent *) override;

    void mousePressEvent(QMouseEvent *) override;

    void mouseReleaseEvent(QMouseEvent *) override;

    void mouseDoubleClickEvent(QMouseEvent *) override;

    void contextMenuEvent(QContextMenuEvent *) override;

    QMenu *createStandardContextMenu();

    virtual void setCompletedText(const QString & /*text*/, bool /*marked*/);

    void setUserSelection(bool userSelection);

    bool autoSuggest() const;

    void paintEvent(QPaintEvent *ev) override;

private:
    const QScopedPointer<KLineEditPrivate> d_ptr;

    Q_PRIVATE_SLOT(d_func(), void _k_textChanged(const QString &))
    Q_PRIVATE_SLOT(d_func(), void _k_completionMenuActivated(QAction *))
    Q_PRIVATE_SLOT(d_func(), void _k_tripleClickTimeout())
    Q_PRIVATE_SLOT(d_func(), void _k_restoreSelectionColors())
    Q_PRIVATE_SLOT(d_func(), void _k_completionBoxTextChanged(const QString &))
};

#endif