ocombobox.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) 2000 Carsten Pfeiffer <pfeiffer@kde.org>
       Opie Project          Copyright (C) 2000 Dawit Alemayehu <adawit@kde.org>

              =.             Originally part of the KDE projects
            .=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 OCOMBOBOX_H
#define OCOMBOBOX_H

/* QT */

#include <qcombobox.h>

/* OPIE */

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

/* FORWARDS */

class QListBoxItem;
class QPopupMenu;
class OCompletionBox;
typedef QString OURL;

class OComboBox : public QComboBox, public OCompletionBase
{
  Q_OBJECT

  //Q_PROPERTY( bool autoCompletion READ autoCompletion WRITE setAutoCompletion )
  //Q_PROPERTY( bool contextMenuEnabled READ isContextMenuEnabled WRITE setContextMenuEnabled )
  //Q_PROPERTY( bool urlDropsEnabled READ isURLDropsEnabled WRITE setURLDropsEnabled )

public:

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

    OComboBox( bool rw, QWidget *parent=0, const char *name=0 );

    virtual ~OComboBox();

    //void setEditURL( const OURL& url );

    //void insertURL( const OURL& url, int index = -1 );

    //void insertURL( const QPixmap& pixmap, const OURL& url, int index = -1 );

    //void changeURL( const OURL& url, int index );

    //void changeURL( const QPixmap& pixmap, const OURL& url, int index );

    int cursorPosition() const { return ( lineEdit() ) ? lineEdit()->cursorPosition() : -1; }

    virtual void setAutoCompletion( bool autocomplete );

    bool autoCompletion() const {
        return completionMode() == OGlobalSettings::CompletionAuto;
    }

    virtual void setContextMenuEnabled( bool showMenu );

    bool isContextMenuEnabled() const { return m_bEnableMenu; }

    //void setURLDropsEnabled( bool enable );

    //bool isURLDropsEnabled() const;

    bool contains( const QString& text ) const;

    void setTrapReturnKey( bool trap );

    bool trapReturnKey() const;

    virtual bool eventFilter( QObject *, QEvent * );

    OCompletionBox * completionBox( bool create = true );

    virtual void setLineEdit( OLineEdit * );

signals:
    void returnPressed();

    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:

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

    virtual void setCompletedText( const QString& );

    void setCompletedItems( const QStringList& items );

  public:
    void setCurrentItem( const QString& item, bool insert = false, int index = -1 );
    void setCurrentItem(int index);

protected slots:

    virtual void itemSelected( QListBoxItem* ) {};

    virtual void makeCompletion( const QString& );

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

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

private:
    // Constants that represent the ID's of the popup menu.
    // TODO: See if we can replace this mess with OActionMenu
    // in the future though this is working lovely.
    enum MenuID {
        Default=0,
        Cut,
        Copy,
        Paste,
        Clear,
        Unselect,
        SelectAll,
        NoCompletion,
        AutoCompletion,
        ShellCompletion,
        PopupCompletion,
        SemiAutoCompletion
    };

    void init();
    void deleteWordBack();
    void deleteWordForward();

    bool m_bEnableMenu;

    // indicating if we should stop return-key events from propagating
    bool m_trapReturnKey;

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


class OPixmapProvider;

class OHistoryCombo : public OComboBox
{
    Q_OBJECT
    Q_PROPERTY( QStringList historyItems READ historyItems WRITE setHistoryItems )

public:
    OHistoryCombo( QWidget *parent = 0L, const char *name = 0L );

    // ### merge these two constructors
    OHistoryCombo( bool useCompletion,
                   QWidget *parent = 0L, const char *name = 0L );

    ~OHistoryCombo();

    inline void setHistoryItems( QStringList items ) {
        setHistoryItems(items, false);
    }

    void setHistoryItems( QStringList items, bool setCompletionList );

    QStringList historyItems() const;

    bool removeFromHistory( const QString& item );

    void setPixmapProvider( OPixmapProvider *prov );

    OPixmapProvider * pixmapProvider() const { return myPixProvider; }

    void reset() { slotReset(); }

public slots:
    void addToHistory( const QString& item );

    void clearHistory();

signals:
    void cleared();

protected:
    virtual void keyPressEvent( QKeyEvent * );


    void insertItems( const QStringList& items );

    bool useCompletion() const { return compObj() != 0L; }

private slots:
    void slotReset();

    void slotClear();

    void addContextMenuItems( QPopupMenu* );

private:
    void init( bool useCompletion );

    int myIterateIndex;

    QString myText;

    bool myRotated;
    OPixmapProvider *myPixProvider;

private:
    class OHistoryComboPrivate;
    OHistoryComboPrivate *d;
};


#endif

---