kcompletionbox.h

Go to the documentation of this file.

/* This file is part of the KDE libraries

   Copyright (c) 2000 Carsten Pfeiffer <pfeiffer@kde.org>
                 2000 Stefan Schimanski <1Stein@gmx.de>
                 2000,2001,2002,2003,2004 Dawit Alemayehu <adawit@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library 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
   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., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef KCOMPLETIONBOX_H
#define KCOMPLETIONBOX_H

#include <klistwidget.h>

class QEvent;

class KDEUI_EXPORT KCompletionBox : public KListWidget
{
    Q_OBJECT
    Q_PROPERTY( bool isTabHandling READ isTabHandling WRITE setTabHandling )
    Q_PROPERTY(QString cancelledText READ cancelledText WRITE setCancelledText)
    Q_PROPERTY( bool activateOnSelect READ activateOnSelect WRITE setActivateOnSelect )

public:
    explicit KCompletionBox( QWidget *parent = 0 );

    ~KCompletionBox();

    virtual QSize sizeHint() const;

    bool activateOnSelect() const;

public Q_SLOTS:
    QStringList items() const;

    void insertItems( const QStringList& items, int index = -1 );

    void setItems( const QStringList& items );

    virtual void popup();

    void setTabHandling( bool enable );

    bool isTabHandling() const;

    void setCancelledText( const QString& txt);

    QString cancelledText() const;

    void setActivateOnSelect(bool state);


    void down();

    void up();

    void pageDown();

    void pageUp();

    void home();

    void end();

    virtual void setVisible( bool visible );

Q_SIGNALS:
    void activated( const QString& );

    void userCancelled( const QString& );

protected:
    QRect calculateGeometry() const;

    void sizeAndPosition();

    virtual bool eventFilter( QObject *, QEvent * );

    virtual QPoint globalPositionHint() const;

protected Q_SLOTS:
    virtual void slotActivated( QListWidgetItem * );

private Q_SLOTS:
    void canceled();
    void slotItemClicked( QListWidgetItem * );

private:
    class KCompletionBoxPrivate;
    KCompletionBoxPrivate* const d;
};


#endif // KCOMPLETIONBOX_H