olineedit.h

Go to the documentation of this file.

/*
  This file                  Copyright (C) 2003 Michael 'Mickey' Lauer <mickey@tm.informatik.uni-frankfurt.de>
    is part of the           Copyright (C) 2001 Carsten Pfeiffer <pfeiffer@kde.org>, Dawit Alemayehu <adawit@kde.org>
       Opie Project          Copyright (C) 1999 Preston Brown <pbrown@kde.org>, Patrick Ward <PAT_WARD@HP-USA-om5.om.hp.com>
                             Copyright (C) 1997 Sven Radej (sven.radej@iname.com)
              =.
            .=l.
           .>+-=
 _;:,     .>    :=|.         This program is free software; you can
.> <`_,   >  .   <=          redistribute it and/or  modify it under
:`=1 )Y*s>-.--   :           the terms of the GNU Library General Public
.="- .-=="i,     .._         License as published by the Free Software
 - .   .-<_>     .<>         Foundation; either version 2 of the License,
     ._= =}       :          or (at your option) any later version.
    .%`+i>       _;_.
    .i_,=:_.      -<s.       This program 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
..}^=.=       =       ;      Library General Public License for more
++=   -.     .`     .:       details.
 :     =  ...= . :.=-
 -.   .:....=;==+<;          You should have received a copy of the GNU
  -_. . .   )=.  =           Library General Public License along with
    --        :-=`           this library; see the file COPYING.LIB.
                             If not, write to the Free Software Foundation,
                             Inc., 59 Temple Place - Suite 330,
                             Boston, MA 02111-1307, USA.

*/

#ifndef OLINEEDIT_H
#define OLINEEDIT_H

/* QT */

#include <qlineedit.h>

/* OPIE */

#include <opie2/ocompletion.h>
#include <opie2/ocompletionbase.h>

class QPopupMenu;

class OCompletionBox;
typedef QString KURL; //class KURL;

class OLineEdit : public QLineEdit, public OCompletionBase
{
    friend class OComboBox;

    Q_OBJECT
    Q_PROPERTY( bool contextMenuEnabled READ isContextMenuEnabled WRITE setContextMenuEnabled )
    Q_PROPERTY( bool urlDropsEnabled READ isURLDropsEnabled WRITE setURLDropsEnabled )

public:

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

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

    virtual ~OLineEdit ();

    void setURL( const KURL& url );

    void cursorAtEnd() { end( false ); }

    virtual void setCompletionMode( OGlobalSettings::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 * );

    OCompletionBox * completionBox( bool create = true );

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


signals:

    void returnPressed( const QString& );

    void completion( const QString& );

    void substringCompletion( const QString& );

    void textRotation( OCompletionBase::KeyBindingType );

    void completionModeChanged( OGlobalSettings::Completion );

    void aboutToShowContextMenu( QPopupMenu* );

public slots:

    virtual void setReadOnly(bool);

    void rotateText( OCompletionBase::KeyBindingType /* type */ );

    virtual void setCompletedText( const QString& );

    void setCompletedItems( const QStringList& items );

    virtual void clear();
    
protected slots:

    virtual void makeCompletion( const QString& );

    void slotAboutToShow() {}

    void slotCancelled() {}

protected:

    virtual void keyPressEvent( QKeyEvent * );

    virtual void mousePressEvent( QMouseEvent * );

    virtual void mouseDoubleClickEvent( QMouseEvent * );

    virtual QPopupMenu *createPopupMenu();

    //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*/ );

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

private slots:
    void completionMenuActivated( int id );
    void tripleClickTimeout();  // resets possibleTripleClick

private:
    // Constants that represent the ID's of the popup menu.
    // TODO: See if we can replace this mess with KActionMenu
    // in the future though it's working lovely.
    enum MenuID {
        Default = 42,
        NoCompletion,
        AutoCompletion,
        ShellCompletion,
        PopupCompletion,
        SemiAutoCompletion
    };

    void init();

    void makeCompletionBox();

    //bool overrideAccel (const QKeyEvent* e);

    bool m_bEnableMenu;

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

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

#endif

---