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 <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 <tqlineedit.h>
#include <kcompletion.h>
 
class TQPopupMenu;
 
class TDECompletionBox;
class KURL;

 
class TDEUI_EXPORT KLineEdit : public TQLineEdit, public TDECompletionBase
{
    friend class KComboBox;
 
    TQ_OBJECT
    TQ_PROPERTY( bool contextMenuEnabled READ isContextMenuEnabled WRITE setContextMenuEnabled )
    TQ_PROPERTY( bool urlDropsEnabled READ isURLDropsEnabled WRITE setURLDropsEnabled )
    TQ_PROPERTY( bool trapEnterKeyEvent READ trapReturnKey WRITE setTrapReturnKey )
    TQ_PROPERTY( bool enableSqueezedText READ isSqueezedTextEnabled WRITE setEnableSqueezedText )
    // @since 3.5.4
    TQ_PROPERTY( TQString clickMessage READ clickMessage WRITE setClickMessage )
 
public:

    KLineEdit( const TQString &string, TQWidget *parent, const char *name = 0 );

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

    virtual ~KLineEdit ();

    void setURL( const KURL& url );

    void cursorAtEnd() { end( false ); }

    virtual void setCompletionMode( TDEGlobalSettings::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( TQObject *, TQEvent * );

    TDECompletionBox * completionBox( bool create = true );

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

    virtual void copy() const;

    void setEnableSqueezedText( bool enable );

    bool isSqueezedTextEnabled() const;

    TQString originalText() const;

    void setCompletionBox( TDECompletionBox *box );

    void setClickMessage( const TQString &msg );

    TQString clickMessage() const;
 
signals:

    void completionBoxActivated (const TQString &);

    void returnPressed( const TQString& );

    void completion( const TQString& );

    void substringCompletion( const TQString& );

    void textRotation( TDECompletionBase::KeyBindingType );

    void completionModeChanged( TDEGlobalSettings::Completion );

    void aboutToShowContextMenu( TQPopupMenu * p );
 
public slots:

    virtual void setReadOnly(bool);

    void rotateText( TDECompletionBase::KeyBindingType type );

    virtual void setCompletedText( const TQString& );

    void setCompletedItems( const TQStringList& items );

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

    virtual void clear();

    void setSqueezedText( const TQString &text);

    virtual void setText ( const TQString& );
 
 
protected slots:

    virtual void makeCompletion( const TQString& );

    void slotAboutToShow() {}

    void slotCancelled() {}

    void userCancelled(const TQString & cancelText);
 
protected:

    virtual void resizeEvent( TQResizeEvent * );

    virtual void keyPressEvent( TQKeyEvent * );

    virtual void mousePressEvent( TQMouseEvent * );

    virtual void mouseDoubleClickEvent( TQMouseEvent * );

    virtual void mouseReleaseEvent( TQMouseEvent * );

    virtual void contextMenuEvent( TQContextMenuEvent * );

    virtual TQPopupMenu *createPopupMenu();

    virtual void drawContents( TQPainter *p );

    virtual void dropEvent( TQDropEvent * );
 
    /*
    * 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 TQString& /*text*/, bool /*marked*/ );
 

    void setUserSelection( bool userSelection );

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

    virtual void focusInEvent( TQFocusEvent* );

    virtual void focusOutEvent( TQFocusEvent* );

    bool autoSuggest() const;
 
private slots:
    void completionMenuActivated( int id );
    void tripleClickTimeout();  // resets possibleTripleClick
    void slotRestoreSelectionColors();
    void setTextWorkaround( const TQString& 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 TQKeyEvent* 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