/****************************************************************************

**

** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtGui module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef QCOMBOBOX_H

#define QCOMBOBOX_H

#include <QtGui/qwidget.h>

#include <QtGui/qabstractitemdelegate.h>

#include <QtCore/qabstractitemmodel.h>

#include <QtCore/qvariant.h>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(Gui)

#ifndef QT_NO_COMBOBOX

class QAbstractItemView;

class QLineEdit;

class QComboBoxPrivate;

class QCompleter;

class Q_GUI_EXPORT QComboBox : public QWidget

{

    Q_OBJECT

    Q_ENUMS(InsertPolicy)

    Q_ENUMS(SizeAdjustPolicy)

    Q_PROPERTY(bool editable READ isEditable WRITE setEditable)

    Q_PROPERTY(int count READ count)

    Q_PROPERTY(QString currentText READ currentText)

    Q_PROPERTY(int currentIndex READ currentIndex WRITE setCurrentIndex NOTIFY currentIndexChanged)

    Q_PROPERTY(int maxVisibleItems READ maxVisibleItems WRITE setMaxVisibleItems)

    Q_PROPERTY(int maxCount READ maxCount WRITE setMaxCount)

    Q_PROPERTY(InsertPolicy insertPolicy READ insertPolicy WRITE setInsertPolicy)

    Q_PROPERTY(SizeAdjustPolicy sizeAdjustPolicy READ sizeAdjustPolicy WRITE setSizeAdjustPolicy)

    Q_PROPERTY(int minimumContentsLength READ minimumContentsLength WRITE setMinimumContentsLength)

    Q_PROPERTY(QSize iconSize READ iconSize WRITE setIconSize)

#ifndef QT_NO_COMPLETER

    Q_PROPERTY(bool autoCompletion READ autoCompletion WRITE setAutoCompletion DESIGNABLE false)

    Q_PROPERTY(Qt::CaseSensitivity autoCompletionCaseSensitivity READ autoCompletionCaseSensitivity WRITE setAutoCompletionCaseSensitivity DESIGNABLE false)

#endif // QT_NO_COMPLETER

    Q_PROPERTY(bool duplicatesEnabled READ duplicatesEnabled WRITE setDuplicatesEnabled)

    Q_PROPERTY(bool frame READ hasFrame WRITE setFrame)

    Q_PROPERTY(int modelColumn READ modelColumn WRITE setModelColumn)

public:

    explicit QComboBox(QWidget *parent = 0);

    ~QComboBox();

    int maxVisibleItems() const;

    void setMaxVisibleItems(int maxItems);

    int count() const;

    void setMaxCount(int max);

    int maxCount() const;

#ifndef QT_NO_COMPLETER

    bool autoCompletion() const;

    void setAutoCompletion(bool enable);

    Qt::CaseSensitivity autoCompletionCaseSensitivity() const;

    void setAutoCompletionCaseSensitivity(Qt::CaseSensitivity sensitivity);

#endif

    bool duplicatesEnabled() const;

    void setDuplicatesEnabled(bool enable);

    void setFrame(bool);

    bool hasFrame() const;

    inline int findText(const QString &text,

                        Qt::MatchFlags flags = Qt::MatchExactly|Qt::MatchCaseSensitive) const

        { return findData(text, Qt::DisplayRole, flags); }

    int findData(const QVariant &data, int role = Qt::UserRole,

                 Qt::MatchFlags flags = Qt::MatchExactly|Qt::MatchCaseSensitive) const;

    enum InsertPolicy {

        NoInsert,

        InsertAtTop,

        InsertAtCurrent,

        InsertAtBottom,

        InsertAfterCurrent,

        InsertBeforeCurrent,

        InsertAlphabetically

#if defined(QT3_SUPPORT) && !defined(Q_MOC_RUN)

        ,

        NoInsertion = NoInsert,

        AtTop = InsertAtTop,

        AtCurrent = InsertAtCurrent,

        AtBottom = InsertAtBottom,

        AfterCurrent = InsertAfterCurrent,

        BeforeCurrent = InsertBeforeCurrent

#endif

    };

#ifdef QT3_SUPPORT

    typedef InsertPolicy Policy;

#endif

    InsertPolicy insertPolicy() const;

    void setInsertPolicy(InsertPolicy policy);

    enum SizeAdjustPolicy {

        AdjustToContents,

        AdjustToContentsOnFirstShow,

        AdjustToMinimumContentsLength, // ### Qt 5: remove

        AdjustToMinimumContentsLengthWithIcon

    };

    SizeAdjustPolicy sizeAdjustPolicy() const;

    void setSizeAdjustPolicy(SizeAdjustPolicy policy);

    int minimumContentsLength() const;

    void setMinimumContentsLength(int characters);

    QSize iconSize() const;

    void setIconSize(const QSize &size);

    bool isEditable() const;

    void setEditable(bool editable);

    void setLineEdit(QLineEdit *edit);

    QLineEdit *lineEdit() const;

#ifndef QT_NO_VALIDATOR

    void setValidator(const QValidator *v);

    const QValidator *validator() const;

#endif

#ifndef QT_NO_COMPLETER

    void setCompleter(QCompleter *c);

    QCompleter *completer() const;

#endif

    QAbstractItemDelegate *itemDelegate() const;

    void setItemDelegate(QAbstractItemDelegate *delegate);

    QAbstractItemModel *model() const;

    void setModel(QAbstractItemModel *model);

    QModelIndex rootModelIndex() const;

    void setRootModelIndex(const QModelIndex &index);

    int modelColumn() const;

    void setModelColumn(int visibleColumn);

    int currentIndex() const;

    QString currentText() const;

    QString itemText(int index) const;

    QIcon itemIcon(int index) const;

    QVariant itemData(int index, int role = Qt::UserRole) const;

    inline void addItem(const QString &text, const QVariant &userData = QVariant());

    inline void addItem(const QIcon &icon, const QString &text,

                        const QVariant &userData = QVariant());

    inline void addItems(const QStringList &texts)

        { insertItems(count(), texts); }

    inline void insertItem(int index, const QString &text, const QVariant &userData = QVariant());

    void insertItem(int index, const QIcon &icon, const QString &text,

                    const QVariant &userData = QVariant());

    void insertItems(int index, const QStringList &texts);

    void insertSeparator(int index);

    void removeItem(int index);

    void setItemText(int index, const QString &text);

    void setItemIcon(int index, const QIcon &icon);

    void setItemData(int index, const QVariant &value, int role = Qt::UserRole);

    QAbstractItemView *view() const;

    void setView(QAbstractItemView *itemView);

    QSize sizeHint() const;

    QSize minimumSizeHint() const;

    virtual void showPopup();

    virtual void hidePopup();

    bool event(QEvent *event);

public Q_SLOTS:

    void clear();

    void clearEditText();

    void setEditText(const QString &text);

    void setCurrentIndex(int index);

Q_SIGNALS:

    void editTextChanged(const QString &);

    void activated(int index);

    void activated(const QString &);

    void highlighted(int index);

    void highlighted(const QString &);

    void currentIndexChanged(int index);

    void currentIndexChanged(const QString &);

protected:

    void focusInEvent(QFocusEvent *e);

    void focusOutEvent(QFocusEvent *e);

    void changeEvent(QEvent *e);

    void resizeEvent(QResizeEvent *e);

    void paintEvent(QPaintEvent *e);

    void showEvent(QShowEvent *e);

    void hideEvent(QHideEvent *e);

    void mousePressEvent(QMouseEvent *e);

    void mouseReleaseEvent(QMouseEvent *e);

    void keyPressEvent(QKeyEvent *e);

    void keyReleaseEvent(QKeyEvent *e);

    void wheelEvent(QWheelEvent *e);

    void contextMenuEvent(QContextMenuEvent *e);

    void inputMethodEvent(QInputMethodEvent *);

    QVariant inputMethodQuery(Qt::InputMethodQuery) const;

    void initStyleOption(QStyleOptionComboBox *option) const;

#ifdef QT3_SUPPORT

public:

    QT3_SUPPORT_CONSTRUCTOR QComboBox(QWidget *parent, const char *name);

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

    inline QT3_SUPPORT int currentItem() const { return currentIndex(); }

    inline QT3_SUPPORT void setCurrentItem(int index) { setCurrentIndex(index); }

    inline QT3_SUPPORT InsertPolicy insertionPolicy() const { return insertPolicy(); }

    inline QT3_SUPPORT void setInsertionPolicy(InsertPolicy policy) { setInsertPolicy(policy); }

    inline QT3_SUPPORT bool editable() const { return isEditable(); }

    inline QT3_SUPPORT void popup() { showPopup(); }

    inline QT3_SUPPORT void setCurrentText(const QString& text) {

        int i = findText(text);

        if (i != -1)

            setCurrentIndex(i);

        else if (isEditable())

            setEditText(text);

        else

            setItemText(currentIndex(), text);

    }

    inline QT3_SUPPORT QString text(int index) const { return itemText(index); }

    inline QT3_SUPPORT QPixmap pixmap(int index) const

    { return itemIcon(index).pixmap(iconSize(), isEnabled() ? QIcon::Normal : QIcon::Disabled); }

    inline QT3_SUPPORT void insertStringList(const QStringList &list, int index = -1)

        { insertItems((index < 0 ? count() : index), list); }

    inline QT3_SUPPORT void insertItem(const QString &text, int index = -1)

        { insertItem((index < 0 ? count() : index), text); }

    inline QT3_SUPPORT void insertItem(const QPixmap &pix, int index = -1)

        { insertItem((index < 0 ? count() : index), QIcon(pix), QString()); }

    inline QT3_SUPPORT void insertItem(const QPixmap &pix, const QString &text, int index = -1)

        { insertItem((index < 0 ? count() : index), QIcon(pix), text); }

    inline QT3_SUPPORT void changeItem(const QString &text, int index)

        { setItemText(index, text); }

    inline QT3_SUPPORT void changeItem(const QPixmap &pix, int index)

        { setItemIcon(index, QIcon(pix)); }

    inline QT3_SUPPORT void changeItem(const QPixmap &pix, const QString &text, int index)

        { setItemIcon(index, QIcon(pix)); setItemText(index, text); }

    inline QT3_SUPPORT void clearValidator() { setValidator(0); }

    inline QT3_SUPPORT void clearEdit() { clearEditText(); }

Q_SIGNALS:

    QT_MOC_COMPAT void textChanged(const QString &);

#endif

protected:

    QComboBox(QComboBoxPrivate &, QWidget *);

private:

    Q_DECLARE_PRIVATE(QComboBox)

    Q_DISABLE_COPY(QComboBox)

    Q_PRIVATE_SLOT(d_func(), void _q_itemSelected(const QModelIndex &item))

    Q_PRIVATE_SLOT(d_func(), void _q_emitHighlighted(const QModelIndex &))

    Q_PRIVATE_SLOT(d_func(), void _q_emitCurrentIndexChanged(const QModelIndex &index))

    Q_PRIVATE_SLOT(d_func(), void _q_returnPressed())

    Q_PRIVATE_SLOT(d_func(), void _q_resetButton())

    Q_PRIVATE_SLOT(d_func(), void _q_dataChanged(const QModelIndex &, const QModelIndex &))

    Q_PRIVATE_SLOT(d_func(), void _q_rowsAboutToBeInserted(const QModelIndex & parent, int start, int end))

    Q_PRIVATE_SLOT(d_func(), void _q_rowsInserted(const QModelIndex & parent, int start, int end))

    Q_PRIVATE_SLOT(d_func(), void _q_rowsAboutToBeRemoved(const QModelIndex & parent, int start, int end))

    Q_PRIVATE_SLOT(d_func(), void _q_rowsRemoved(const QModelIndex & parent, int start, int end))

    Q_PRIVATE_SLOT(d_func(), void _q_modelDestroyed())

    Q_PRIVATE_SLOT(d_func(), void _q_modelReset())

#ifdef QT_KEYPAD_NAVIGATION

    Q_PRIVATE_SLOT(d_func(), void _q_completerActivated())

#endif

};

inline void QComboBox::addItem(const QString &atext, const QVariant &auserData)

{ insertItem(count(), atext, auserData); }

inline void QComboBox::addItem(const QIcon &aicon, const QString &atext,

                               const QVariant &auserData)

{ insertItem(count(), aicon, atext, auserData); }

inline void QComboBox::insertItem(int aindex, const QString &atext,

                                  const QVariant &auserData)

{ insertItem(aindex, QIcon(), atext, auserData); }

#endif // QT_NO_COMBOBOX

QT_END_NAMESPACE

QT_END_HEADER

#endif // QCOMBOBOX_H