phoneapp/phoneuiutils/src/tphonecmdparamglobalnote.cpp
author William Roberts <williamr@symbian.org>
Thu, 22 Jul 2010 16:33:21 +0100
branchGCC_SURGE
changeset 51 f39ed5e045e0
parent 30 ebdbd102c78a
parent 46 bc5a64e5bc3c
permissions -rw-r--r--
Catchup to latest Symbian^4

/*
* 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: Implementation of TPhoneCmdParamGlobalNote class.
*
*/


// INCLUDE FILES
#include <avkon.hrh>
#include "tphonecmdparamglobalnote.h"
#include "phoneui.pan" 

// ================= MEMBER FUNCTIONS =======================

// -----------------------------------------------------------------------------
// TPhoneCmdParamGlobalNote::TPhoneCmdParamGlobalNote
// C++ default constructor can NOT contain any code, that
// might leave.
// -----------------------------------------------------------------------------
//
EXPORT_C TPhoneCmdParamGlobalNote::TPhoneCmdParamGlobalNote():
    TPhoneCommandParam(),
    iType( EAknGlobalErrorNote ),
    iTextResourceId( 0 ),
    iText( KNullDesC ),
    iTone( EAvkonSIDErrorTone ),
    iWaitforReady ( EFalse ),
    iSoftkeys( 0 ),
    iTimeout( 0 ),
    iNotificationDialog( EFalse ),
    iCauseCode( KErrNotFound ) 
    {
    iParamId = EPhoneParamIdGlobalNote;
    }

// ---------------------------------------------------------
// TPhoneCmdParamGlobalNote::SetType
// Sets the global note type
// (other items were commented in a header).
// ---------------------------------------------------------
//
EXPORT_C void TPhoneCmdParamGlobalNote::SetType( TAknGlobalNoteType aType )
   {
   iType = aType;   
   }

// ---------------------------------------------------------
// TPhoneCmdParamGlobalNote::SetTextResourceId
// Sets the global note resource ID
// (other items were commented in a header).
// ---------------------------------------------------------
//
EXPORT_C void TPhoneCmdParamGlobalNote::SetTextResourceId( 
   TInt aTextResourceId )
   {
    __ASSERT_DEBUG( aTextResourceId, 
        Panic( EPhoneUtilsParameterNotInitialized ) );
   iTextResourceId = aTextResourceId;   
   }

// ---------------------------------------------------------
// TPhoneCmdParamGlobalNote::SetText
// Sets the global note text
// (other items were commented in a header).
// ---------------------------------------------------------
//
EXPORT_C void TPhoneCmdParamGlobalNote::SetText( 
   const TDesC& aText )
   {
   iText.Set( aText );
   }

// ---------------------------------------------------------
// TPhoneCmdParamGlobalNote::SetTone
// Sets the global note tone
// (other items were commented in a header).
// ---------------------------------------------------------
//
EXPORT_C void TPhoneCmdParamGlobalNote::SetTone( TInt aTone )
   {
   iTone = aTone;   
   }

// ---------------------------------------------------------
// TPhoneCmdParamGlobalNote::SetWaitForReady
// Sets the note to wait for completed
// (other items were commented in a header).
// ---------------------------------------------------------
//
EXPORT_C void TPhoneCmdParamGlobalNote::SetWaitForReady( TBool aStatus )
   {
   iWaitforReady = aStatus;   
   }

// ---------------------------------------------------------
// TPhoneCmdParamGlobalNote::SetSoftkeys
// Sets the global note softkeys
// (other items were commented in a header).
// ---------------------------------------------------------
//
EXPORT_C void TPhoneCmdParamGlobalNote::SetSoftkeys( TInt aSoftkeys )
   {
   iSoftkeys = aSoftkeys;   
   }

// ---------------------------------------------------------
// TPhoneCmdParamGlobalNote::SetTimeout
// Sets the timeout value for a note.
// (other items were commented in a header).
// ---------------------------------------------------------
//
EXPORT_C void TPhoneCmdParamGlobalNote::SetTimeout( TInt aTimeout )
{
    iTimeout = aTimeout;
}

// ---------------------------------------------------------
// TPhoneCmdParamGlobalNote::SetNotificationDialog
// Sets the notification dialog flag.
// (other items were commented in a header).
// ---------------------------------------------------------
//
EXPORT_C void TPhoneCmdParamGlobalNote::SetNotificationDialog( 
        TBool aNotificationDialog )
{
    iNotificationDialog = aNotificationDialog;
}

// ---------------------------------------------------------
// TPhoneCmdParamGlobalNote::SetCauseCode
// Sets the cause code.
// (other items were commented in a header).
// ---------------------------------------------------------
//
EXPORT_C void TPhoneCmdParamGlobalNote::SetCauseCode( 
        TInt aCauseCode )
{
    iCauseCode = aCauseCode;
}

// ---------------------------------------------------------
// TPhoneCmdParamGlobalNote::Type
// Returns the global note type
// (other items were commented in a header).
// ---------------------------------------------------------
//
EXPORT_C TAknGlobalNoteType TPhoneCmdParamGlobalNote::Type() const
   {
   return iType;
   }

// ---------------------------------------------------------
// TPhoneCmdParamGlobalNote::TextResourceId
// Returns the global note text resource ID
// (other items were commented in a header).
// ---------------------------------------------------------
//
EXPORT_C TInt TPhoneCmdParamGlobalNote::TextResourceId() const
   {
   return iTextResourceId;
   }

// ---------------------------------------------------------
// TPhoneCmdParamGlobalNote::Text
// Returns the global note text
// (other items were commented in a header).
// ---------------------------------------------------------
//
EXPORT_C const TDesC& TPhoneCmdParamGlobalNote::Text() const
   {
   return iText;
   }

// ---------------------------------------------------------
// TPhoneCmdParamGlobalNote::Tone
// Returns the note tone
// (other items were commented in a header).
// ---------------------------------------------------------
//
EXPORT_C TInt TPhoneCmdParamGlobalNote::Tone() const
   {
   return iTone;
   }

// ---------------------------------------------------------
// TPhoneCmdParamGlobalNote::WaitForReady
// Returns the status of wait for completed
// (other items were commented in a header).
// ---------------------------------------------------------
//
EXPORT_C TBool TPhoneCmdParamGlobalNote::WaitForReady() const
   {
   return iWaitforReady;
   }
   
// ---------------------------------------------------------
// TPhoneCmdParamGlobalNote::Softkeys
// Returns the note softkeys
// (other items were commented in a header).
// ---------------------------------------------------------
//
EXPORT_C TInt TPhoneCmdParamGlobalNote::Softkeys() const
   {
   return iSoftkeys;
   }

// ---------------------------------------------------------
// TPhoneCmdParamGlobalNote::Timeout
// Returns the timeout value.
// ---------------------------------------------------------
//
EXPORT_C TInt TPhoneCmdParamGlobalNote::Timeout() const
    {
    return iTimeout;
    }

// ---------------------------------------------------------
// TPhoneCmdParamGlobalNote::NotificationDialog
// Returns the notification dialog flag.
// ---------------------------------------------------------
//
EXPORT_C TBool TPhoneCmdParamGlobalNote::NotificationDialog() const
    {
    return iNotificationDialog;
    }

// ---------------------------------------------------------
// TPhoneCmdParamGlobalNote::CauseCode
// Returns the cause code.
// ---------------------------------------------------------
//
EXPORT_C TInt TPhoneCmdParamGlobalNote::CauseCode() const
    {
    return iCauseCode;
    }

//  End of File