/*

* Copyright (c) 2005 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: 

*   See class description.

*

*/

#ifndef __TPHONECMDPARAMGLOBALNOTE_H

#define __TPHONECMDPARAMGLOBALNOTE_H

//  INCLUDES

#include <w32std.h>

#include "tphonecommandparam.h"

// DATA TYPES

// CLASS DECLARATION

/**

*  A parameter class for global note information.

*/

class TPhoneCmdParamGlobalNote : public TPhoneUICommandParam

    {   

    public:  

        /**

        * C++ default constructor.

        */

        IMPORT_C TPhoneCmdParamGlobalNote();

    public: 

        /**

        * Sets the global note type.

        * @param aType is the global note type

        */

        IMPORT_C void SetType( TAknGlobalNoteType aType );

        /**

        * Sets the text resource ID for the global note

        * @param aResourceId is the global note resource ID

        */

        IMPORT_C void SetTextResourceId( TInt aTextResourceId );

        /**

        * Sets the text for the global note.

        * @param aText is the global note text

        */

        IMPORT_C void SetText( const TDesC& aText );

        /**

        * Sets the global note tone.

        * @param aTone is the note tone

        */

        IMPORT_C void SetTone( TInt aTone );

        /**

        * Sets the global note wait status.

        * @param aStatus Wait for completed or not

        */

        IMPORT_C void SetWaitForReady( TBool aStatus );

        /**

        * Sets the global note softkeys.

        * @param aTone is the note softkeys

        */

        IMPORT_C void SetSoftkeys( TInt aSoftkeys );

        /**

        * Sets timeout for a note.

        * @param    aTimeout    Timeout in milliseconds. If timeout == 0 then 

        * default timeout is used. If timeout < 0 the note is not closed 

        * automatically.

        */

        IMPORT_C void SetTimeout( TInt aTimeout );

        /**

        * Sets notification dialog flag.

        * @param aNotificationDialog True if notification dialog 

        *        should be used.

        */

        IMPORT_C void SetNotificationDialog( TBool aNotificationDialog );

        /**

        * Sets cause code.

        * @param aCauseCode Cause code.

        */

        IMPORT_C void SetCauseCode( TInt aCauseCode );

        /**

        * Returns the global note type

        * @return Returns the type

        */

        IMPORT_C TAknGlobalNoteType Type() const;

        /**

        * Returns the global note text resource ID.

        * @return Returns the global note text resource ID.

        */

        IMPORT_C TInt TextResourceId() const;

        /**

        * Returns the global note text

        * @return Returns the text

        */

        IMPORT_C const TDesC& Text() const;

        /**

        * Returns the global note tone.

        * @return Returns the global note tone

        */

        IMPORT_C TInt Tone() const;

        /**

        * Gets the global note wait status

        * @return  ETrue if wait for completed

        */

        IMPORT_C TBool WaitForReady() const;

        /**

        * Returns the global note softkeys.

        * @return Returns the global note softkeys

        */

        IMPORT_C TInt Softkeys() const;

        /**

         * Returns the timeout value.

         * @return   Timeout value.

         */

        IMPORT_C TInt Timeout() const;

        /**

         * Returns the notification dialog flag.

         * @return Notification dialog flag.

         */

        IMPORT_C TBool NotificationDialog() const;

        /**

        * Returns cause code.

        * @return Cause code.

        */

        IMPORT_C TInt CauseCode() const;

    private:    

        /**

        * Global note type

        */

        TAknGlobalNoteType iType;

        /**

        * Global note text resource ID

        */

        TInt iTextResourceId;

        /**

        * Global note text

        */

        TPtrC iText;

        /**

        * Global note tone

        */

        TInt iTone;

        /**

        * Wait for ready status

        */

        TBool iWaitforReady;

        /**

        * Global note softkeys

        */

        TInt iSoftkeys;

        /**

        * Timeout for a note.

        */

        TInt iTimeout;

        /**

        * Notification Dialog flag.

        */

        TBool iNotificationDialog;

        /**

        * Cause code. 

        */

        TInt iCauseCode; 

    };

#endif // __TPHONECMDPARAMGLOBALNOTE_H

// End of File