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

**

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

** All rights reserved.

** Contact: Nokia Corporation (developer.feedback@nokia.com)

**

** This file is part of the HbWidgets module of the UI Extensions for Mobile.

**

** GNU Lesser General Public License Usage

** 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 developer.feedback@nokia.com.

**

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

#include "hbcombobox_p.h"

#include <hbcombobox.h>

#include <hblistview.h>

#include <hbtoucharea.h>

#include <hbtextitem.h>

#include <hbstyleoptioncombobox_p.h>

#include <hbnamespace_p.h>

#include <QStandardItemModel>

#include <QGraphicsScene>

#include <QDebug>

#include <hbtapgesture.h>

/*!

    @beta

    @hbwidgets

    \class HbComboBox

    \brief The HbComboBox provides a drop-down list that permits selecting an item.

    A HbComboBox provides a means of presenting a list of options to the user

    in a way that takes up the minimum amount of screen space.

    A combobox is a selection widget that displays the currently selected item,

    and provides a drop-down list that permits selecting an item.

    A HbComboBox with currently selected item

    \image html noneditablecombobox.png.

    A HbComboBox with drop-down list to select an item from list of options

    \image html comboboxdropdownlist.png.

    HbComboBox are of two types:

    1: Editable:

    If combobox is set to editable, tapping on combobox label field invokes the VKB in

    touch environments or accepts input from an attached keyboard. Tapping on 

    button area of combobox launches dropdown list. Choosing an element from 

    the combobox dropdown list replaces the label with the chosen item. Touch events on

    combobox button behaves same in both editable and non-editable combobox.

    2: Non Editable:

    If the combobox is set to non-editable then even tapping on label field will launch 

    drop down unlike editable combobox. Tapping on combobox button area behaves in 

    same way as in editable combobox.

    By default combobox is non-editable. 

    Application is responsible for setting the model in combobox. If no model is set or model

    set is empty then drop down list will not be displayed at all. Combobox owns the model set 

    by application.

    The number of rows to be displayed in HbComboBox drop down can be configured by overriding

    HbComboBox css. By default number of items in drop down is 8 in portrait mode and 5 in

    landscape mode.

    HbComboBox provides four signals:

    \li currentIndexChanged( index ) is emitted when the current selection in the combobox is

    changed either by user interaction or programmatically.

    \li currentIndexChanged( const QString& ) is emitted when the curret selection in the combobox

    is changed by user interaction. If application is setting a differnet index/text

    then this signal is not emmitted.

    \li editTextChanged( const QString& ) is emitted when text is changed in editable combobox.

    \li editingFinished( ) is emitted either because editable combobox lost focus or Return/Enter 

    is pressed.

    The following is an example of how to create a model and adding item in the model.

    HbComboBox takes ownership of model.

    \snippet{ultimatecodesnippet/ultimatecodesnippet.cpp,37}

    An example of how to add strings in HbComboBox and setting currentIndex.

    HbComboBox will creates model internally if model is not created.

    \snippet{ultimatecodesnippet/ultimatecodesnippet.cpp,38}

    An example of how to add stringsList into HbComboBox and setting currentIndex.

    HbComboBox will creates the model internally if model is not created.

    \snippet{ultimatecodesnippet/ultimatecodesnippet.cpp,39}

    An example of how to insert string at some index in HbComboBox.

    HbComboBox will creates the model internally if model is not created.

    \snippet{ultimatecodesnippet/ultimatecodesnippet.cpp,40}

    An example of how to insert StringList at index into HbComboBox.

    HbComboBox will creates the model internally if model is not created.

    \snippet{ultimatecodesnippet/ultimatecodesnippet.cpp,41}

    An example of how to set the items into HbComboBox.

    HbComboBox will replace the existing model.

    \snippet{ultimatecodesnippet/ultimatecodesnippet.cpp,42}

*/

/*!

    Constructs a new HbComboBox with \a parent.

 */

HbComboBox::HbComboBox( QGraphicsItem *parent ):

    HbWidget( *new HbComboBoxPrivate, parent )

{

    Q_D( HbComboBox );

    d->init( );

    updatePrimitives( );

    setFlag(QGraphicsItem::ItemSendsScenePositionChanges);

}

/*!

    Destructor.

 */

HbComboBox::~HbComboBox( )

{

}

/*!

    \internal[protected][Access Privilage]

 */

HbComboBox::HbComboBox( HbComboBoxPrivate &dd, QGraphicsItem *parent ) :

    HbWidget( dd, parent )

{

    Q_D( HbComboBox );

    d->init( );

    updatePrimitives( );

}

/*!

    @beta

    \property HbComboBox::items

    It replaces the existing list with \a texts. If \a texts passed is empty then this function 

    clears the model and returns. 

    \sa clear()

*/

void HbComboBox::setItems( const QStringList &texts )

{  

    if ( texts.isEmpty( ) ) {

        //if string list passed is empty then clear the current items in combobox

        clear();

        return;

    }

    QStandardItemModel* model = new QStandardItemModel( this );

    int textCount = texts.count( );

    for( int i = 0; i < textCount; i++ )

    {

        QStandardItem* standardItem = new QStandardItem( );

        standardItem->setData( texts.at( i ),Qt::DisplayRole );

        model->appendRow( standardItem );

    }

   setModel( model );

}

/*!

    @beta

    This property holds the list added in the combobox.

    By default, for an empty combo box, this property has a empty StringList. 

 */

QStringList HbComboBox::items( ) const

{

    Q_D( const HbComboBox );

    if( d->mModel && d->mModel->rowCount( ) ) {

        QStringList list;

        int rowCount = d->mModel->rowCount( );

        for(int i = 0; i < rowCount; i++) {

            list<<( d->mModel->data( d->mModel->index( i, 0 ) ) ).toString( );

        }

        return list;

    } else {

      return QStringList( );

    }

}

/*!

    @alpha

    Sets \a icon for the item at the given \a index in the combobox.

    This API will not work if applcation sets the model as QStringListModel.

*/

void HbComboBox::setItemIcon( int index, const HbIcon &icon )

{

    Q_D( const HbComboBox );

    if( d->mModel ) {

        QModelIndex item = d->mModel->index( index, 0 );

        if ( item.isValid( ) ) {

            d->mModel->setData( item, icon.qicon( ), Qt::DecorationRole );

        }

    }

}

/*!

    @alpha

    Returns HbIcon at \a index in the combobox.

*/

HbIcon HbComboBox::itemIcon( int index ) const

{

    Q_D( const HbComboBox );

    if( d->mModel ) {

        QModelIndex mi = d->mModel->index( index, 0 );

        if( mi.isValid ( ) ) {

            return d->itemIcon( mi );

        } 

    }

    return HbIcon( );

}

/*!

    @beta

    Either returns the \a role data at this \a index in HbComboBox, or QVariant::Invalid 

    if there is no data for this role.

*/

QVariant HbComboBox::itemData( int index, int role ) const

{

    Q_D( const HbComboBox );

    if( d->mModel ) {

        QModelIndex mi = d->mModel->index( index, 0 );

        if( mi.isValid ( ) ) {

            return d->mModel->data( mi, role );

        }

    }

    return QVariant( );

}

/*!

    @beta

    Sets the \a role data for the item at the given \a index in HbComboBox

    to the specified \a value.

*/

void HbComboBox::setItemData( int index, const QVariant &value, int role )

{

    Q_D( const HbComboBox );

    if( d->mModel ) {

        QModelIndex item = d->mModel->index( index, 0 );

        if ( item.isValid( ) ) {

            d->mModel->setData( item, value, role );

        }

    }

}

/*!

    @beta

    This API is valid only for editable combobox.

    Either returns the validator that is used to constraint text input in

    combobox or returns NULL if it is invalid.

    \sa editable

*/

const HbValidator *HbComboBox::validator( ) const

{

    Q_D( const HbComboBox );

    if( d->mEditable) {

        return d->mLineEdit->validator( );

    }

    return 0;

}

/*!

    @beta

    This API is only valid for the editable combobox.

    Sets the \a validator to be used in editable combobox.

*/

void HbComboBox::setValidator( HbValidator *validator )

{

    Q_D( HbComboBox );

    if( d->mEditable ) {

        disconnect( d->mLineEdit, SIGNAL( textChanged ( QString ) ),

            this, SLOT( _q_textChanged( QString ) ) );

        d->mLineEdit->setValidator( validator );

        connect( d->mLineEdit, SIGNAL( textChanged ( QString ) ),

            this, SLOT( _q_textChanged( QString ) ) );

    }

}

/*!

    @beta

    This property holds the number of items in combobox.

    For an empty combo box, this property is equal to 0.

 */

int HbComboBox::count( ) const

{

    Q_D( const HbComboBox );

    if( d->mModel ) {

        return d->mModel->rowCount( );

    }

    return 0;

}

/*!

    @beta

    Sets the model to \a model 

    Ownership of \a model is taken by HbComboBox.

    It replaces the old model if exists.

    Do not pass 0(NULL) as \a model to clear contents of model instead call clear( ).

    \sa clear

 */

void HbComboBox::setModel( QAbstractItemModel * model )

{

    Q_D( HbComboBox );

    if ( d->mModel != model ) {

        if( model ) {

            d->setModel( model );

        } else {

            clear( );

        }

    }

}

/*!

    @beta

    Returns current model.

 */

QAbstractItemModel* HbComboBox::model( ) const

{

    Q_D( const HbComboBox );

    return d->mModel;

}

/*!

    @beta

    Sets current index to \a index.

    By default no item is selected.

 */

void HbComboBox::setCurrentIndex( int index )

{

    Q_D( HbComboBox );

    if( d->mModel ) {

        QModelIndex mi = d->mModel->index( index, 0 );

        if( mi.isValid( ) ) {

            d->setCurrentIndex( mi );

        }

    }

}

/*!

    @beta

    Either returns index of current item if valid or else returns -1 for invalid current index.

 */

int HbComboBox::currentIndex( ) const

{

    Q_D( const HbComboBox );

    return d->mCurrentIndex.row( );

}

/*!

    @beta

    \fn int HbComboBox::findText(const QString &text, Qt::MatchFlags 

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

    Returns the index of the item containing the given \a text; otherwise

    returns -1.

    The \a flags specify how the items in the combobox are searched.

*/

/*!

    @beta

    Returns the index of the item containing the given \a data for the

    given \a role if valid, otherwise returns -1.

    The \a flags specify how the items in the combobox are searched.

*/

int HbComboBox::findData( const QVariant &data, int role, Qt::MatchFlags flags ) const

{

    Q_D( const HbComboBox );

    if( d->mModel ) {

        QModelIndexList result;

        QModelIndex start = d->mModel->index( 0, 0 );

        result = d->mModel->match( start, role, data, 1, flags );

        if ( result.isEmpty( ) ) {

            return -1;

        }

        return result.first( ).row( );

    }

    return -1;

}

/*!

    @beta

    This API is valid for editable combobox.

    Sets the \a text in editable combobox's line edit.

 */

void HbComboBox::setEditText( const QString &text )

{

    Q_D( HbComboBox );

    if( d->mEditable ) {

        disconnect( d->mLineEdit, SIGNAL( textChanged ( QString ) ),

            this, SLOT( _q_textChanged( QString ) ) );

        d->mLineEdit->setText( text );

        connect( d->mLineEdit, SIGNAL( textChanged ( QString ) ),

            this, SLOT( _q_textChanged( QString ) ) );

    }

}

/*!

    @beta

    \property HbComboBox::currentText

    In case of non-editable combobox it returns the text at current index.

    In case of editable combobox it returns the text in line edit.

*/

QString HbComboBox::currentText( ) const

{

    Q_D( const HbComboBox );

    if( d->mEditable ) {

        return d->mLineEdit->text( );

    }else if( d->mCurrentIndex.isValid( ) ) {

        return itemText ( d->mCurrentIndex.row( ) );

    } else {

        return QString( );

    }

}

/*!

    @beta

    Removes the item at the given \a index from HbComboBox.

    If \a index passed is current index then current index will be updated accordingly.

 */

void HbComboBox::removeItem( int index )

{

    Q_D( HbComboBox );

    if( d->mModel ) {

        int rowCount = d->mModel->rowCount( );

        if( index >=0 && index < rowCount ) {

            bool currentText = false;

            if ( d->mModel->index( index, 0 ) == d->mCurrentIndex ) {

                currentText = true;

                d->mModel->removeRow( index );

            } else if( d->mCurrentIndex.row( ) > index ) {

                 int row = d->mCurrentIndex.row( );

                 d->mModel->removeRow( index );

                 d->mCurrentIndex = d->mModel->index( --row, 0 );

                 d->currentIndexChanged( d->mCurrentIndex );

            } else {

                d->mModel->removeRow( index );

            }

            if( d->mModel->rowCount( ) == 0 ) {

                if( d->mEditable ) {

                    clearEditText( );

                } else {

                    if( d->mLineEdit ) {

                        d->mLineEdit->setText( QString( ) );

                    } else {

                        d->mText.clear( );

                        HbStyleOptionComboBox comboBoxOption;

                        initStyleOption( &comboBoxOption );

                        HbStylePrivate::updatePrimitive(

                            d->mTextItem, HbStylePrivate::P_ComboBox_text, &comboBoxOption );

                    }

                }

                d->mCurrentIndex = QModelIndex();

                return;

            }

            if( currentText ) {

                d->mCurrentIndex = d->mModel->index( 0, 0 );

                if( d->mEditable ) {

                    disconnect(d->mLineEdit, SIGNAL( textChanged ( QString ) ),

                        this, SLOT( _q_textChanged( QString ) ) );

                    d->mLineEdit->setText( d->mModel->data( d->mCurrentIndex ).toString( ) );

                    connect(d->mLineEdit, SIGNAL( textChanged ( QString ) ), 

                        this, SLOT( _q_textChanged( QString ) ) );