klineedit.h

Go to the documentation of this file.

/*  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 <sven.radej@iname.com>
    Copyright (c) 1999 Patrick Ward <PAT_WARD@HP-USA-om5.om.hp.com>
    Copyright (c) 1999 Preston Brown <pbrown@kde.org>

    Completely re-designed:
    Copyright (c) 2000,2001 Dawit Alemayehu <adawit@kde.org>

    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 <QtGui/QLineEdit>

#include <kcompletion.h>

class QAction;
class QMenu;
class KCompletionBox;
class KUrl;
class KLineEditPrivate;

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

    Q_OBJECT
#ifndef KDE_NO_DEPRECATED
    Q_PROPERTY( bool contextMenuEnabled READ isContextMenuEnabled WRITE setContextMenuEnabled )
#endif
    Q_PROPERTY( bool urlDropsEnabled READ urlDropsEnabled WRITE setUrlDropsEnabled )
    Q_PROPERTY( bool trapEnterKeyEvent READ trapReturnKey WRITE setTrapReturnKey )
    Q_PROPERTY( bool squeezedTextEnabled READ isSqueezedTextEnabled WRITE setSqueezedTextEnabled )
    Q_PROPERTY( QString clickMessage READ clickMessage WRITE setClickMessage )
    Q_PROPERTY( bool showClearButton READ isClearButtonShown WRITE setClearButtonShown )
    Q_PROPERTY( bool passwordMode READ passwordMode WRITE setPasswordMode )

public:

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

    explicit KLineEdit( QWidget *parent = 0 );

    virtual ~KLineEdit ();

    void setUrl( const KUrl& url );

    virtual void setCompletionMode( KGlobalSettings::Completion mode );

    void setCompletionModeDisabled( KGlobalSettings::Completion mode, bool disable = true );

#ifndef KDE_NO_DEPRECATED
    virtual KDE_DEPRECATED void setContextMenuEnabled( bool showMenu );
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED bool isContextMenuEnabled() const;
#endif

    void setUrlDropsEnabled( bool enable );

    bool urlDropsEnabled() const;

    void setTrapReturnKey( bool trap );

    bool trapReturnKey() const;

    KCompletionBox * completionBox( bool create = true ); // KDE5 TODO: make virtual, so konq can reimplement i

    virtual void setCompletionObject( KCompletion *, bool hsig = true );

    virtual void copy() const;

    void setSqueezedTextEnabled( bool enable );

    bool isSqueezedTextEnabled() const;

    QString originalText() const;

    QString userText() const;

    void setCompletionBox( KCompletionBox *box );

    void setClickMessage( const QString &msg );

    QString clickMessage() const;

    void setClearButtonShown(bool show);

    bool isClearButtonShown() const;

    QSize clearButtonUsedSize() const;

    void doCompletion(const QString& txt);

Q_SIGNALS:

    void completionBoxActivated (const QString &);

    void returnPressed( const QString& );

    void completion( const QString& );

    void substringCompletion( const QString& );

#ifndef KDE_NO_DEPRECATED
    QT_MOC_COMPAT void userTextChanged( const QString & );
#endif

    void textRotation( KCompletionBase::KeyBindingType );

    void completionModeChanged( KGlobalSettings::Completion );

    void aboutToShowContextMenu(QMenu* menu);

    void clearButtonClicked();

public Q_SLOTS:

    virtual void setReadOnly(bool);

    void rotateText( KCompletionBase::KeyBindingType type );

    virtual void setCompletedText( const QString& );

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

    virtual void clear(); // ### KDE 5: check if still required

    void setSqueezedText( const QString &text);

    virtual void setText ( const QString& );

    void setPasswordMode( bool b = true );

    bool passwordMode( ) const;


protected Q_SLOTS:

    virtual void makeCompletion( const QString& );

    void userCancelled(const QString & cancelText);

protected:

    virtual bool event( QEvent * );

    virtual void resizeEvent( QResizeEvent * );

    virtual void keyPressEvent( QKeyEvent * );

    virtual void mousePressEvent( QMouseEvent * );

    virtual void mouseReleaseEvent( QMouseEvent * );

    virtual void mouseDoubleClickEvent( QMouseEvent * );

    virtual void contextMenuEvent( QContextMenuEvent * );

    QMenu* createStandardContextMenu();

    virtual void dropEvent( QDropEvent * );

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


    void setUserSelection( bool userSelection );

    virtual void create( WId = 0, bool initializeWindow = true,
                         bool destroyOldWindow = true );

    bool autoSuggest() const;

    virtual void paintEvent( QPaintEvent *ev );

    virtual void focusInEvent( QFocusEvent *ev );

    virtual void focusOutEvent( QFocusEvent *ev );

private Q_SLOTS:
    void completionMenuActivated( QAction *act );
    void tripleClickTimeout();  // resets possibleTripleClick
    void slotRestoreSelectionColors();
    void _k_slotCompletionBoxTextChanged( const QString& text );

    void updateClearButtonIcon(const QString&);

private:


    void init();

    bool copySqueezedText( bool clipboard ) const;

    void setSqueezedText ();

    void updateClearButton();

private:
    friend class KLineEditPrivate;
    KLineEditPrivate *const d;

    Q_PRIVATE_SLOT( d, void _k_slotSettingsChanged( int category ) )
    Q_PRIVATE_SLOT( d, void _k_textChanged(const QString&) )
};

#endif