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

**

** 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 HbCore 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 "hbinputeditorinterface.h"

#include "hbinputeditorinterface_p.h"

#include <QGraphicsProxyWidget>

#include <QWidget>

#include <QList>

#include <hbaction.h>

#include <hbwidget.h>

#include "hbinputstandardfilters.h"

#include "hbinputvkbhost.h"

#include "hbabstractvkbhost.h"

#include "hbinpututils.h"

/*!

@hbcore

\class HbEditorInterface

*/

/*!

*/

HbEditorInterface::HbEditorInterface(QObject *editor)

{

    mPrivate = HbEditorInterfacePrivateCache::instance()->attachEditor(editor, this);

    if (mPrivate) {

        connect(mPrivate, SIGNAL(destroyed(QObject *)), this, SLOT(backendDestroyed(QObject *)));

    }

}

/*!

*/

HbEditorInterface::~HbEditorInterface()

{

    // NOTE: We do not delete private object here on purpose, it is owned by the cache.

}

/*!

\sa setTextCase

*/

HbTextCase HbEditorInterface::textCase() const

{

    HbTextCase ret = HbTextCaseNone;

    if (mPrivate) {

        mPrivate->lock();

        ret = mPrivate->mTextCase;

        mPrivate->unlock();

    }

    return ret;

}

/*!

\sa textCase

*/

void HbEditorInterface::setTextCase(HbTextCase textCase)

{

    if (mPrivate) {

        mPrivate->lock();

        mPrivate->mTextCase = textCase;

        mPrivate->unlock();

        HbEditorInterfacePrivateCache::instance()->notifyValueChanged(mPrivate->mHostEditor);

    }

}

/*!

*/

HbInputModeType HbEditorInterface::mode() const

{

    HbInputModeType ret = HbInputModeNone;

    if (mPrivate) {

        mPrivate->lock();

        ret = mPrivate->mInputMode;

        mPrivate->unlock();

    }

    return ret;

}

/*!

*/

void HbEditorInterface::setMode(HbInputModeType inputMode)

{

    if (mPrivate) {

        mPrivate->lock();

        mPrivate->mInputMode = inputMode;

        if (mPrivate->mLastFocusedState.inputMode() != HbInputModeNone) {

            // Update also the last known input state, otherwise it won't really change.

            mPrivate->mLastFocusedState.setInputMode(inputMode);

        }

        mPrivate->unlock();

        HbEditorInterfacePrivateCache::instance()->notifyValueChanged(mPrivate->mHostEditor);

    }

}

/*!

Returns editor constraints. The returned value is a combination of HbEditorConstraint flags.

\sa setInputConstraints

*/

HbEditorConstraints HbEditorInterface::inputConstraints() const

{

    HbEditorConstraints ret = 0;

    if (mPrivate) {

        mPrivate->lock();

        ret = mPrivate->mConstraints;

        mPrivate->unlock();

    }

    return ret;

}

/*!

Sets editor constraints.

\sa inputConstraints

*/

void HbEditorInterface::setInputConstraints(HbEditorConstraints constraints)

{

    if (mPrivate) {

        mPrivate->lock();

        mPrivate->mConstraints = constraints;

        mPrivate->unlock();

        HbEditorInterfacePrivateCache::instance()->notifyValueChanged(mPrivate->mHostEditor);

    }

}

/*!

In some cases, the input framework also automatically sets the filter to match

input method hints. The default filter can still be overridden.

\sa setFilter

*/

HbInputFilter *HbEditorInterface::filter() const

{

    HbInputFilter *ret = 0;

    if (mPrivate) {

        mPrivate->lock();

        ret = mPrivate->mFilter;

        mPrivate->unlock();

    }

    return ret;

}

/*!

\sa filter

*/

void HbEditorInterface::setFilter(HbInputFilter *filter)

{

    if (mPrivate) {

        mPrivate->lock();

        mPrivate->mFilter = filter;

        mPrivate->unlock();

        HbEditorInterfacePrivateCache::instance()->notifyValueChanged(mPrivate->mHostEditor);

    }

}

/*!

\sa setDigitType

*/

HbInputDigitType HbEditorInterface::digitType() const

{

    HbInputDigitType ret = HbDigitTypeNone;

    if (mPrivate) {

        mPrivate->lock();

        ret = mPrivate->mLocalDigitType;

        mPrivate->unlock();

    }

    return ret;

}

/*!

\sa digitType

*/

void HbEditorInterface::setDigitType(HbInputDigitType digitType)

{

    if (mPrivate) {

        mPrivate->lock();

        mPrivate->mLocalDigitType = digitType;

        mPrivate->unlock();

        HbEditorInterfacePrivateCache::instance()->notifyValueChanged(mPrivate->mHostEditor);

    }

}

/*!

When the button is clicked, the action is triggered.

Different input methods may display 0 or more than one button.

\sa insertAction

\sa removeAction

\sa actions

*/

void HbEditorInterface::addAction(HbAction *action)

{

    insertAction(0, action);

}

/*!

\sa addAction

\sa removeAction

\sa actions

*/

void HbEditorInterface::insertAction(HbAction *before, HbAction *action)

{

    if (!action) {

        return;

    }

    if (mPrivate) {

        mPrivate->lock();

        // Remove the action first if it's already in the list

        int index = mPrivate->mActions.indexOf(action);

        if (index >= 0) {

            mPrivate->mActions.removeAt(index);

            disconnect(action, SIGNAL(destroyed(QObject *)),

                       HbEditorInterfacePrivateCache::instance(), SLOT(actionDestroyed(QObject *)));

        }

        int pos = mPrivate->mActions.indexOf(before);

        if (pos < 0) {

            pos = mPrivate->mActions.size();

        }

        mPrivate->mActions.insert(pos, action);

        connect(action, SIGNAL(destroyed(QObject *)),

                HbEditorInterfacePrivateCache::instance(), SLOT(actionDestroyed(QObject *)));

        mPrivate->unlock();

        HbEditorInterfacePrivateCache::instance()->notifyValueChanged(mPrivate->mHostEditor);

    }

}

/*!

Removes the specified action.

\sa addAction

\sa insertAction

\sa actions

*/

void HbEditorInterface::removeAction(HbAction *action)

{

    if (!action) {

        return;

    }

    if (mPrivate) {

        mPrivate->lock();

        mPrivate->mActions.removeAll(action);

        disconnect(action, SIGNAL(destroyed(QObject *)),

                   HbEditorInterfacePrivateCache::instance(), SLOT(actionDestroyed(QObject *)));

        mPrivate->unlock();

        HbEditorInterfacePrivateCache::instance()->notifyValueChanged(mPrivate->mHostEditor);

    }

}

/*!

Returns this editor's list of actions.

\sa addAction

\sa insertAction

\sa removeAction

*/

QList<HbAction *> HbEditorInterface::actions() const

{

    QList<HbAction *> ret;

    if (mPrivate) {

        mPrivate->lock();

        ret = mPrivate->mActions;

        mPrivate->unlock();

    }

    return ret;

}

/*!

\sa setExtraDictionaryId

\sa HbUserDictionary

\sa HbExtraUserDictionary

*/

int HbEditorInterface::extraDictionaryId() const

{

    int ret = 0;

    if (mPrivate) {

        mPrivate->lock();

        ret = mPrivate->mExtraDictionaryId;

        mPrivate->unlock();

    }

    return ret;

}

/*!

\sa extraDictionaryId

\sa HbUserDictionary

\sa HbExtraUserDictionary

*/

void HbEditorInterface::setExtraDictionaryId(int id)

{

    if (mPrivate) {

        mPrivate->lock();

        mPrivate->mExtraDictionaryId = id;

        mPrivate->unlock();

        HbEditorInterfacePrivateCache::instance()->notifyValueChanged(mPrivate->mHostEditor);

    }

}

/*!

*/

HbInputEditorClass HbEditorInterface::editorClass() const

{