• Skip to content
• Skip to link menu

KDE 3.5 API Reference

• KDE API Reference
• API Reference

• Sitemap
• Contact Us

 

kdeui

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 <qlineedit.h>
#include <kcompletion.h>

class QPopupMenu;

class KCompletionBox;
class KURL;

class KDEUI_EXPORT KLineEdit : public QLineEdit, public KCompletionBase
{
    friend class KComboBox;

    Q_OBJECT
    Q_PROPERTY( bool contextMenuEnabled READ isContextMenuEnabled WRITE setContextMenuEnabled )
    Q_PROPERTY( bool urlDropsEnabled READ isURLDropsEnabled WRITE setURLDropsEnabled )
    Q_PROPERTY( bool trapEnterKeyEvent READ trapReturnKey WRITE setTrapReturnKey )
    Q_PROPERTY( bool enableSqueezedText READ isSqueezedTextEnabled WRITE setEnableSqueezedText )
    // @since 3.5.4
    Q_PROPERTY( QString clickMessage READ clickMessage WRITE setClickMessage )

public:

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

    KLineEdit ( QWidget *parent=0, const char *name=0 );

    virtual ~KLineEdit ();

    void setURL( const KURL& url );

    void cursorAtEnd() { end( false ); }

    virtual void setCompletionMode( KGlobalSettings::Completion mode );

    virtual void setContextMenuEnabled( bool showMenu ) {  m_bEnableMenu = showMenu; }

    bool isContextMenuEnabled() const { return m_bEnableMenu; }

    void setURLDropsEnabled( bool enable );

    bool isURLDropsEnabled() const;

    void setTrapReturnKey( bool trap );

    bool trapReturnKey() const;

    virtual bool eventFilter( QObject *, QEvent * );

    KCompletionBox * completionBox( bool create = true );

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

    virtual void copy() const;

    void setEnableSqueezedText( bool enable );

    bool isSqueezedTextEnabled() const;

    QString originalText() const;

    void setCompletionBox( KCompletionBox *box );

    void setClickMessage( const QString &msg );

    QString clickMessage() const;

signals:

    void completionBoxActivated (const QString &);

    void returnPressed( const QString& );

    void completion( const QString& );

    void substringCompletion( const QString& );

    void textRotation( KCompletionBase::KeyBindingType );

    void completionModeChanged( KGlobalSettings::Completion );

    void aboutToShowContextMenu( QPopupMenu * p );

public slots:

    virtual void setReadOnly(bool);

    void rotateText( KCompletionBase::KeyBindingType type );

    virtual void setCompletedText( const QString& );

    void setCompletedItems( const QStringList& items );

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

    virtual void clear();

    void setSqueezedText( const QString &text);

    virtual void setText ( const QString& );


protected slots:

    virtual void makeCompletion( const QString& );

    void slotAboutToShow() {}

    void slotCancelled() {}

    void userCancelled(const QString & cancelText);

protected:

    virtual void resizeEvent( QResizeEvent * );

    virtual void keyPressEvent( QKeyEvent * );

    virtual void mousePressEvent( QMouseEvent * );

    virtual void mouseDoubleClickEvent( QMouseEvent * );

    virtual void mouseReleaseEvent( QMouseEvent * );

    virtual void contextMenuEvent( QContextMenuEvent * );

    virtual QPopupMenu *createPopupMenu();

    virtual void drawContents( QPainter *p );

    virtual void dropEvent( QDropEvent * );

    /*
    * This function simply sets the lineedit text and
    * highlights the text appropriately if the boolean
    * value is set to true.
    *
    * @param text
    * @param marked
    */
    virtual void setCompletedText( const QString& /*text*/, bool /*marked*/ );


    void setUserSelection( bool userSelection );

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

    virtual void focusInEvent( QFocusEvent* );

    virtual void focusOutEvent( QFocusEvent* );

    bool autoSuggest() const;

private slots:
    void completionMenuActivated( int id );
    void tripleClickTimeout();  // resets possibleTripleClick
    void slotRestoreSelectionColors();
    void setTextWorkaround( const QString& text );

private:

    // Constants that represent the ID's of the popup menu.
    enum MenuID
    {
        Default = 42,
        NoCompletion,
        AutoCompletion,
        ShellCompletion,
        PopupCompletion,
        ShortAutoCompletion,
        PopupAutoCompletion
    };

    void init();

    bool copySqueezedText( bool clipboard ) const;

    bool overrideAccel (const QKeyEvent* e);

    void setSqueezedText ();

    bool m_bEnableMenu;

    bool possibleTripleClick;  // set in mousePressEvent, deleted in tripleClickTimeout

protected:
    virtual void virtual_hook( int id, void* data );
private:
    class KLineEditPrivate;
    KLineEditPrivate *d;
};

#endif

kdeui

Skip menu "kdeui"

• Main Page
• Namespace List
• Class Hierarchy
• Alphabetical List
• Class List
• File List
• Namespace Members
• Class Members
• Related Pages

API Reference

Skip menu "API Reference"

• dcop
• DNSSD
• interfaces
• Kate
• kconf_update
• KDECore
• KDED
• kdefx
• KDEsu
• kdeui
• KDocTools
• KHTML
• KImgIO
• KInit
• kio
• kioslave
• KJS
• KNewStuff
• KParts
• KUtils

Generated for API Reference by doxygen 1.5.9
This website is maintained by Adriaan de Groot and Allen Winter.
KDE^® and the K Desktop Environment^® logo are registered trademarks of KDE e.V. | Legal