kcombobox.h

/* This file is part of the KDE libraries
 
   Copyright (c) 2000,2001 Dawit Alemayehu <adawit@kde.org>
   Copyright (c) 2000,2001 Carsten Pfeiffer <pfeiffer@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 _KCOMBOBOX_H
#define _KCOMBOBOX_H
 
#include <tqlineedit.h>
#include <tqcombobox.h>
#include <tqvbox.h>
#include <tqlabel.h>
#include <tqlayout.h>
#include <tqtoolbutton.h>
#include <tqheader.h>
 
#include <kcompletion.h>
#include <kdialogbase.h>
#include <tdelistview.h>
 
class TQListBoxItem;
class TQPopupMenu;
class TQLineEdit;
 
class TDECompletionBox;
class KURL;

class TDEUI_EXPORT KComboBox : public TQComboBox, public TDECompletionBase
{
  TQ_OBJECT
  TQ_PROPERTY( bool autoCompletion READ autoCompletion WRITE setAutoCompletion )
  TQ_PROPERTY( bool contextMenuEnabled READ isContextMenuEnabled WRITE setContextMenuEnabled )
  TQ_PROPERTY( bool urlDropsEnabled READ isURLDropsEnabled WRITE setURLDropsEnabled )
  TQ_PROPERTY( bool trapReturnKey READ trapReturnKey WRITE setTrapReturnKey )
 
public:

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

    KComboBox( bool rw, TQWidget *parent=0, const char *name=0 );

    virtual ~KComboBox();

    void setEditURL( const KURL& url );

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

    void insertURL( const TQPixmap& pixmap, const KURL& url, int index = -1 );

    void changeURL( const KURL& url, int index );

    void changeURL( const TQPixmap& pixmap, const KURL& url, int index );

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

    virtual void setAutoCompletion( bool autocomplete );

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

    virtual void setContextMenuEnabled( bool showMenu );

    bool isContextMenuEnabled() const { return m_bEnableMenu; }

    void setURLDropsEnabled( bool enable );

    bool isURLDropsEnabled() const;

    bool contains( const TQString& text ) const;

    void setTrapReturnKey( bool trap );

    bool trapReturnKey() const;

    virtual bool eventFilter( TQObject *, TQEvent * );

    TDECompletionBox * completionBox( bool create = true );

    virtual void setLineEdit( TQLineEdit * );
 
signals:
    void returnPressed();

    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:

    void rotateText( TDECompletionBase::KeyBindingType type );

    virtual void setCompletedText( const TQString& );

    void setCompletedItems( const TQStringList& items );

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

    void setCurrentItem(int index) { TQComboBox::setCurrentItem(index); }
 
protected slots:

    virtual void itemSelected( TQListBoxItem* ) {}

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

    virtual void create( WId = 0, bool initializeWindow = true,
                         bool destroyOldWindow = true );
 
    virtual void wheelEvent( TQWheelEvent *ev );
 
private slots:
    void lineEditDeleted();
 
private:
    void init();
    bool m_bEnableMenu; // ### BCI: unused, remove in KDE4
    bool m_trapReturnKey; // ### BCI: unused, remove in KDE4
 
protected:
    virtual void virtual_hook( int id, void* data );
 
private:
    class KComboBoxPrivate;
    KComboBoxPrivate* const d;
};
 
 
class KPixmapProvider;

class TDEUI_EXPORT KHistoryCombo : public KComboBox
{
    TQ_OBJECT
    TQ_PROPERTY( TQStringList historyItems READ historyItems WRITE setHistoryItems )
 
public:
    KHistoryCombo( TQWidget *parent = 0L, const char *name = 0L );
 
    // ### merge these two constructors
    KHistoryCombo( bool useCompletion,
           TQWidget *parent = 0L, const char *name = 0L );

    ~KHistoryCombo();

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

    void setHistoryItems( TQStringList items, bool setCompletionList );

    TQStringList historyItems() const;

    bool removeFromHistory( const TQString& item );

    void setPixmapProvider( KPixmapProvider *prov );

    KPixmapProvider * pixmapProvider() const { return myPixProvider; }

    void reset() { slotReset(); }

    void setHistoryEditorEnabled( bool enable );
    bool isHistoryEditorEnabled() const;
 
public slots:
    void addToHistory( const TQString& item );

    void clearHistory();
 
signals:
    void cleared();
 
    void removed( const TQString& item );
 
protected:
    virtual void keyPressEvent( TQKeyEvent * );

    virtual void wheelEvent( TQWheelEvent *ev );

    void insertItems( const TQStringList& items );

    bool useCompletion() const { return compObj(); }
 
private slots:
    void slotReset();

    void slotClear();

    void slotEdit();

    void addContextMenuItems( TQPopupMenu* );
 
    void slotRemoveFromHistory( const TQString & );
 
private:
    void init( bool useCompletion );
    void rotateUp();
    void rotateDown();

    int myIterateIndex;

    TQString myText;

    bool myRotated;
    KPixmapProvider *myPixProvider;
 
protected:
    virtual void virtual_hook( int id, void* data );
private:
    class KHistoryComboPrivate;
    KHistoryComboPrivate* const d;
};
 
class TDEUI_EXPORT KHistoryComboEditor : public KDialogBase
{
    TQ_OBJECT
 
public:
    KHistoryComboEditor( const TQStringList& entries, TQWidget *parent = 0L );
    ~KHistoryComboEditor();
 
signals:
    void removeFromHistory( const TQString& );
 
protected slots:
    virtual void slotUser1(); // User1 is "Delete Entry" button
    void slotSelectionChanged( TQListViewItem * item );
 
protected:
    virtual void virtual_hook( int id, void* data );
 
private:
    TDEListView *m_pListView;
 
    class KHistoryComboEditorPrivate;
    KHistoryComboEditorPrivate* const d;
};
 
#endif