/*

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

 * All rights reserved.

 * This component and the accompanying materials are made available

 * under the terms of "Eclipse Public License v1.0"

 * which accompanies this distribution, and is available

 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

 *

 * Initial Contributors:

 * Nokia Corporation - initial contribution.

 *

 * Contributors:

 *

 * Description:  

 *

 */

#ifndef CPPHONENOTES_H

#define CPPHONENOTES_H

#include <QObject>

#include <QString>

#include <QQueue>

#include <hbmessagebox.h>

#include <psetcalldivertingwrapper.h>

#include "cptelephonyutilsdefs.h"

class CpSettingsWrapper;

using namespace CpTelephonyUtils;

class CPTELEPHONYUTILS_EXPORT CpPhoneNotes: public QObject

{

    Q_OBJECT

public:

    static CpPhoneNotes* instance();

private: 

    CpPhoneNotes();

    ~CpPhoneNotes();

    Q_DISABLE_COPY(CpPhoneNotes)

signals:

    /**

     This signal is emitted when the device progress dialog is cancelled by 

     user pressing the "cancel" button or by the application itself.

     @param     noteId      On return contains unique note identifier.

     */

    void progressNoteCanceled();

public slots: // Slots: 

    /**

     Shows global progress note. Note showing may be delayed if other note 

     showing is ongoing. 

     @param     noteId      On return contains unique note identifier.

     @param     text        Text to show on a note.

     */

    void showGlobalProgressNote(int &noteId, const QString& text);

    /**

     Shows global note. Note showing may be delayed if other note 

     showing is ongoing. 

     @param     noteId      On return contains unique note identifier.

     @param     text        Text to show on a note.

     @param     noteType    Note type.

     */

    void showGlobalNote(int &noteId, const QString& text, 

        HbMessageBox::MessageBoxType noteType);

    /**

     Shows global error note. Note showing may be delayed if other note 

     showing is ongoing. 

     @param     noteId      On return contains unique note identifier.

     @param     errorCode   Code specifying error situation. 

     */

    void showGlobalErrorNote(int &noteId, int errorCode);

    /**

     Shows the basic service list.

     @param     title                   Heading to be used for the list.

     @param     basicServiceGroupIds    Basic services to be listed. 

     */

    void showBasicServiceList(

        const QString &title, 

        const QList<unsigned char> &basicServiceGroupIds);

    /**

     Shows detailed call divert information about the selected divert service

     group.

     @param     divertStatus    Divert status information.

     */

    void showCallDivertDetails(

        const PSCallDivertingStatus &divertStatus);

    /**

     Cancels specified note.

     @param     noteId      Note identifier.

     */

    void cancelNote(int noteId);

    /**

     Retuns true if note is currently shown.

     */

    bool noteShowing();

private:

    /**

     Resolves basic service group name by identifier.

     @param     basicServiceGroupId     Group identifier.

     @return    Group name.

     */

    QString basicServiceGroupName(BasicServiceGroups basicServiceGroupId) const;

    /**

     Formats phone number according to locale specific rules.

     @param     number          Unformatted phone number.

     @return    Formatted number.

     */

    QString formatPhoneNumber(QString number) const;

    /**

     Launches next note in the queue if not busy with showing other 

     note currently.

     */

    void launchNextNoteIfReady();

private: // Data: 

    /**

      Cenrep settings wrapper.

     */

     CpSettingsWrapper *m_cpSettingsWrapper;

    /**

      Notes waiting to be shown.

     */

    QQueue<QObject*> *m_notesQueue;

    /**

      Indicates whether note controller is busy with some note showing.

     */

    bool m_isNoteShowingOngoing;

};

#endif // CPPHONENOTES_H