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

**

** 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.

**

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

/*!

    \class HbIndicator

    \stable

    \hbcore

*/

/*!

    \enum HbIndicator::ErrorRange

    Defines indicator error ranges.

*/

/*!

    \var HbIndicator::ErrorRange HbIndicator::FrameworkErrors

*/

/*!

    \var HbIndicator::ErrorRange HbIndicator::PluginErrors

    Start of an error range for errors originating from indicator plugins.

*/

/*!

    \var HbIndicator::ErrorRange HbIndicator::ErrorTypeMask

    Mask for error type part of the error code.

*/

/*!

    \fn void HbIndicator::userActivated(const QString &type, const QVariantMap &data)

    @param data Data sent by indicator.

*/

#include "hbindicator.h"

#include <QtGlobal>

#include <QDataStream>

// indicators are implemented only for Symbian/S60 OS. All others use a stub which shows

// indicators in the calling process.

#if defined(Q_OS_SYMBIAN)

#include "hbindicatorsym_p.h"

#else

#include "hbindicatorwin32_p.h"

#endif // defined(Q_OS_SYMBIAN)

/*!

    Constructs an indicator object. \a parent is a pointer to the parent.

*/

HbIndicator::HbIndicator(QObject *parent) :

    QObject(parent), d_ptr(new HbIndicatorPrivate)

{

    Q_D(HbIndicator);

    d->q_ptr = this;

    d->init();

}

HbIndicator::HbIndicator(HbIndicatorPrivate &dd, QObject *parent) :

    QObject(parent), d_ptr(&dd)

{

    Q_D(HbIndicator);

    d->q_ptr = this;

    d->init();

}

HbIndicator::~HbIndicator()

{

    delete d_ptr;

}

/*!

 */

bool HbIndicator::activate(const QString &indicatorType, const QVariant &parameter)

{

    return d_func()->activate(indicatorType, parameter);

}

/*!

 */

bool HbIndicator::deactivate(const QString &indicatorType, const QVariant &parameter)

{

    return d_func()->deactivate(indicatorType, parameter);

}

/*!

    Returns the last error code. The code is cleared when any other API function than error() is called.

*/

int HbIndicator::error() const

{

    return d_func()->error();

}