/*

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

*

*    Support for setting item lists and their setting

*    items.  THe setting item list owns a listbox and an array of

*    setting items. The latter provides a MDesCArray interface for the

*    listbox model.

*

*    Setting Items are abstractions of data types, that

*    have a capability to launch setting pages.

*

*

*/

#include <gulicon.h>

#include <coemain.h>

//For TResourceReader

#include <barsread.h>

#include <avkon.hrh>

#include <avkon.rsg>

#include <avkon.mbg>

// For Numbered and unnumbered setting style lists

#include <aknlists.h>

#include <aknnotewrappers.h>

#include <aknlayoutscalable_avkon.cdl.h>

#include <aknconsts.h>

// For layout switch events

#include "AknDef.h"

// For proper icon array management

#include "AknIconArray.h"

#include "aknsettingitemlist.h"

#include "akntextsettingpage.h"

#include "aknvolumesettingpage.h"

#include "aknslidersettingpage.h"

#include "aknmfnesettingpage.h"

#include "aknpopupsettingpage.h"

#include "aknpasswordsettingpage.h"

#include <AknsConstants.h>

#include "akntrace.h"

const TInt KAknSettingItemMaxNumberDigits = 3; // for the setting item numbers

const TInt KAknSettingItemArrayGranularity = 5;

const TInt KAknSettingItemTimeBufferLength = 30;

const TInt KAknSettingItemIpTextBufferLength = 15; //Assumes 4 fields of 3 + 3 dots

// Separator for listbox text decoration

_LIT(KListBoxTextSeparator, "\t");

// Format for a number

_LIT(KAknSettingItemDecimalFormat, "%d" );

// Space used for listbox and time offset text formatting

_LIT(KAknSettingItemSingleSpace, " " );

// Plus and minus used for listbox time offset

_LIT(KAknSettingItemPlus, "+" );

_LIT(KAknSettingItemMinus, "-" );

// Empty IP address

_LIT(KAknSettingItemEmptyIpAddress, "0.0.0.0" );

enum TAknSettingItemListPanic

    {

    EAknPanicSettingItemListUnused,

    EAknPanicSettingItemListNoEmptyText,

    EAknPanicSettingItemListInsufficientResource,

    EAknPanicSettingItemListInconsistentControlType,

    EAknPanicSettingItemListInvalidPasswordMode,

    EAknPanicSettingItemListInvalidDateMode,

    EAknPanicSettingItemListInvalidEnumeratedValue,

    EAknPanicSettingItemListWrongNumberOfValues,

    EAknPanicSettingItemListRequiredValueNotInArray,

    EAknPanicSettingItemListInvalidIndex,

    EAknPanicSettingItemListConstructionNotComplete,

    EAknPanicSettingItemListArrayLengthsMisMatch,

    EAknPanicSettingItemListNotBinaryCompatible,

    EAknPanicSettingItemListInvalidPointer,

    EAknPanicSettingItemListBadIcon

    };

GLDEF_C void Panic(TAknSettingItemListPanic aPanic)

    {

    _LIT(KPanicCat,"Setting Item List");

    User::Panic(KPanicCat, aPanic);

    }

// -------------------------------

// CAknSettingItemExtension

// -------------------------------

//

NONSHARABLE_CLASS( CAknSettingItemExtension ) : public CBase

    {

    public:

    static CAknSettingItemExtension* NewL();

    ~CAknSettingItemExtension();

    void CreateLockIconL(CArrayPtr<CGulIcon>* aIconArray);

    protected:

    void ConstructL();

    private:

    CAknSettingItemExtension();

    //members

    public:

    TInt iLockIconIndex;

    TInt iLockIconHighlightIndex;

    private:

    };

CAknSettingItemExtension::CAknSettingItemExtension()

: iLockIconIndex(KErrNotFound), iLockIconHighlightIndex(KErrNotFound)

    {

    }

CAknSettingItemExtension::~CAknSettingItemExtension()

    {

    }

void CAknSettingItemExtension::ConstructL()

    {

    }

CAknSettingItemExtension* CAknSettingItemExtension::NewL()

    {

    CAknSettingItemExtension* settingExtension = new (ELeave) CAknSettingItemExtension;

    CleanupStack::PushL(settingExtension);

    settingExtension->ConstructL();

    CleanupStack::Pop(settingExtension);

    return settingExtension;

    }

void CAknSettingItemExtension::CreateLockIconL(CArrayPtr<CGulIcon>* aIconArray)

    {

    // START of lock icon creation

    // Create the lock icon as the last icon in the table

    CFbsBitmap* skinnedBitmap = NULL;

    CFbsBitmap* skinnedMask = NULL;

    // Make the icon and put it in the array

    CGulIcon* icon = CGulIcon::NewL();

    CleanupStack::PushL(icon);

    MAknsSkinInstance* skin = AknsUtils::SkinInstance();

    // Create color icon

    AknsUtils::CreateColorIconL(skin, KAknsIIDQgnIndiSettProtectedAdd,

                                KAknsIIDQsnIconColors, EAknsCIQsnIconColorsCG13,

                                skinnedBitmap, skinnedMask, KAvkonBitmapFile,

                                EMbmAvkonQgn_indi_sett_protected_add,

                                EMbmAvkonQgn_indi_sett_protected_add_mask, KRgbBlack);

    icon->SetMask(skinnedMask);// ownership transferred

    icon->SetBitmap(skinnedBitmap); // ownership transferred

    if(iLockIconIndex == KErrNotFound)

        {

        aIconArray->AppendL( icon );

        iLockIconIndex = aIconArray->Count() - 1;

        }

    else

        {

        delete aIconArray->At(iLockIconIndex);

        aIconArray->Delete(iLockIconIndex);

        aIconArray->InsertL(iLockIconIndex, icon);

        }

    CleanupStack::Pop(); // icon

    // Create the lock icon for highlight

    skinnedBitmap = NULL;

    skinnedMask = NULL;

    // Make the icon and put it in the array

    icon = CGulIcon::NewL();

    CleanupStack::PushL(icon);

    // Create color icon

    AknsUtils::CreateColorIconL(skin, KAknsIIDQgnIndiSettProtectedAdd,

                                KAknsIIDQsnIconColors, EAknsCIQsnIconColorsCG16,

                                skinnedBitmap, skinnedMask, KAvkonBitmapFile,

                                EMbmAvkonQgn_indi_sett_protected_add,

                                EMbmAvkonQgn_indi_sett_protected_add_mask, KRgbBlack);

    icon->SetMask(skinnedMask);// ownership transferred

    icon->SetBitmap(skinnedBitmap); // ownership transferred

    if(iLockIconHighlightIndex == KErrNotFound)

        {

        aIconArray->AppendL( icon );

        iLockIconHighlightIndex = aIconArray->Count() - 1;

        }

    else

        {

        delete aIconArray->At(iLockIconHighlightIndex);

        aIconArray->Delete(iLockIconHighlightIndex);

        aIconArray->InsertL(iLockIconHighlightIndex, icon);

        }

    CleanupStack::Pop(); // icon

    // END of lock icon creation

    }

// -------------------------------

// CAknSettingItem

// -------------------------------

//

// public:

/**

* Default constructor.

*/

EXPORT_C CAknSettingItem::CAknSettingItem( TInt aIdentifier) : iIdentifier( aIdentifier )

    {

    }

EXPORT_C CAknSettingItem::~CAknSettingItem()

    {

    delete iExtension;

    delete iSettingName;

    delete iListBoxText;

    delete iEmptyItemText;

    delete iCompulsoryText;

    }

EXPORT_C void CAknSettingItem::ConstructL(

    const TBool aIsNumberedStyle,

    const TInt aOrdinal,

    const TDesC& aSettingName,

    CArrayPtr<CGulIcon>* aIconArray,

    TInt aSettingPageResourceId,

    TInt aEditorControlType,

    TInt aSettingEditorResourceId,

    TInt aAssociatedResourceId)

    {

    _AKNTRACE_FUNC_ENTER;

    iExtension = CAknSettingItemExtension::NewL();

    if ( aIsNumberedStyle )

        iFlags |= EIsNumberedStyle;

    else

        iFlags &= (~EIsNumberedStyle);

    iOrdinal = aOrdinal;

    HBufC* newText = aSettingName.AllocL();

    delete( iSettingName ); // after the AllocL succeeds

    iSettingName = newText;

    iIconArray = aIconArray;

    iSettingPageResourceId = aSettingPageResourceId;

    iEditorControlType = aEditorControlType;

    iSettingEditorResourceId = aSettingEditorResourceId;

    iAssociatedResourceId = aAssociatedResourceId;

    // Give the derived classes a chance to use the additional resource id:

    CompleteConstructionL();

    // Perform the initial load of the data

    LoadL();

    CFbsBitmap* bitmap = CreateBitmapL(); // This is a test to see if the setting item HAS a bitmap to offfer

    if ( bitmap )

        {

        CleanupStack::PushL(bitmap);

        // Make the icon and put it in the array

        CGulIcon* icon = CGulIcon::NewL();

        icon->SetBitmap( bitmap ); // ownership transferred

        CleanupStack::Pop(); // bitmap;

        CleanupStack::PushL( icon );

        iIconArray->AppendL( icon );

        CleanupStack::Pop(); // icon

        iIconIndex = iIconArray->Count() - 1;

        iFlags |= EHasIcon;

        // This is repeated to catch any mask information that might be available

        bitmap = CreateBitmapL();

        if ( bitmap )

            icon->SetBitmap( bitmap ); // ownership transferred

        }

    else

        {

        iFlags &= (~EHasIcon);

        }

    // Finally this sets up the text for the MDcaPoint calls from listbox

    UpdateListBoxTextL();

    _AKNTRACE_FUNC_EXIT;

    }

/**

* This routine is used to replace the old bitmap with a new one.

*

*/

void CAknSettingItem::UpdateBitmapL()

    {

    if (HasIcon() )

        {

        CFbsBitmap* bitmap = CreateBitmapL();

        if ( bitmap )

            {

            // This deletes the old one as the bitmaps are owned

            iIconArray->At(iIconIndex)->SetBitmap( bitmap );

            }

        }

    }

EXPORT_C void CAknSettingItem::StoreL()

    {

    }

EXPORT_C void CAknSettingItem::LoadL()

    {

    }

EXPORT_C CFbsBitmap* CAknSettingItem::CreateBitmapL()

    {

    return 0;

    }

EXPORT_C TBool CAknSettingItem::IsNumberedStyle() const

    {

    return (iFlags & EIsNumberedStyle );

    }

EXPORT_C TBool CAknSettingItem::IsHidden() const

    {

    return (iFlags & EIsHidden );

    }

EXPORT_C void CAknSettingItem::SetHidden(TBool aHidden)

    {

    if ( aHidden )

        iFlags |= EIsHidden;

    else

        iFlags &= (~EIsHidden);

    // Note the the client code needs to do any recalculation and re-presentation of the listbox

    }

EXPORT_C TPtrC CAknSettingItem::SettingName()

    {

    return (TPtrC) *iSettingName;

    }

/**

* Returns the ordinal for the setting. Only valid the numberstyle is Numbered;

* if not it returns the "NOt displaeyd" value

*/

EXPORT_C TInt CAknSettingItem::SettingNumber() const

    {

    if (IsNumberedStyle())

        return iOrdinal;

    else

        return EAknSettingPageNoOrdinalDisplayed;

    }

EXPORT_C HBufC* CAknSettingItem::ListBoxText()

    {

    return iListBoxText;

    }

EXPORT_C const TDesC& CAknSettingItem::SettingTextL()

    {

    return EmptyItemText();

    }

EXPORT_C TBool CAknSettingItem::HasIcon() const

    {

    return (iFlags & EHasIcon );

    }

EXPORT_C void CAknSettingItem::EditItemL( TBool /* aCalledFromMenu */)

    {

    }

EXPORT_C void CAknSettingItem::HandleSettingPageEventL(CAknSettingPage* /* aSettingPage */,MAknSettingPageObserver::TAknSettingPageEvent /* aEventType */ )

    {

    _AKNTRACE_FUNC_ENTER;

    UpdateListBoxTextL();

    _AKNTRACE_FUNC_EXIT;

    }

/**

*

*/

EXPORT_C void CAknSettingItem::SetSettingPage( CAknSettingPage* aSettingPage )

    {

    iSettingPage = aSettingPage;

    }

/**

*

*/

EXPORT_C CAknSettingPage* CAknSettingItem::SettingPage() const

    {

    return iSettingPage;

    }

/**

*

*  Set up the setting page in the standard way

*

*

*/

EXPORT_C void CAknSettingItem::SetUpStandardSettingPageL()

    {

    SettingPage()->SetSettingTextL( SettingName() );

    if ( IsNumberedStyle() )

        {

        SettingPage()->SetSettingNumberL( SettingNumber() );

        SettingPage()->SetNumbered(ETrue);

        }

    else

        SettingPage()->SetNumbered(EFalse); // Suppress the numbering

    }

/**

*

*

*

*/

EXPORT_C TInt CAknSettingItem::SettingPageResourceId() const

    {

    return iSettingPageResourceId;

    }

/**

* Access method for the setting editor resource id

*

*

*/

EXPORT_C TInt CAknSettingItem::SettingEditorResourceId() const

    {

    return iSettingEditorResourceId;

    }

/**

* Access function for the associated resource Id

*

*

*/

EXPORT_C TInt CAknSettingItem::AssociatedResourceId() const

    {

    return iAssociatedResourceId;

    }

EXPORT_C void CAknSettingItem::UpdateListBoxTextL()

    {

    _AKNTRACE_FUNC_ENTER;

    // Get rid of the old value

    delete iListBoxText;

    iListBoxText = 0;

    // Update the bitmap

    UpdateBitmapL();

    if((iFlags & EViewOnly) || (iFlags & EProtected))

        {

        iExtension->CreateLockIconL(iIconArray);

        }

    // Calculate the right length

    TInt lengthRequired = 2 * KAknSettingItemMaxNumberDigits;

    lengthRequired += 4 * KListBoxTextSeparator().Length();

    lengthRequired += (SettingName().Length() );

    lengthRequired += (SettingTextL().Length() );

    if (iCompulsoryText)

        {

        lengthRequired += (iCompulsoryText->Length() );

        }

    if ( ProtectionState() == ESettingItemViewOnly ||

            ProtectionState() == ESettingItemProtected )

        {

        lengthRequired += 4 * KAknSettingItemMaxNumberDigits; // 4*3

        }

    // Create the buffer

    iListBoxText = HBufC::NewL( lengthRequired );

    TPtr listBoxTextPtr = iListBoxText->Des();

    if ( iFlags & EIsNumberedStyle )

        {

        // Locale-specific number conversion of this is done in listbox code, so not

        // done here

        listBoxTextPtr.Format( KAknSettingItemDecimalFormat, iOrdinal );

        }

    else

        {

        listBoxTextPtr.Copy( KAknSettingItemSingleSpace );

        }

    listBoxTextPtr.Append( KListBoxTextSeparator ); // index 1

    listBoxTextPtr.Append( SettingName() );

    listBoxTextPtr.Append( KListBoxTextSeparator ); // index 2

    if ( HasIcon() )

        {

        TBuf<KAknSettingItemMaxNumberDigits> iconIndexText;

        iconIndexText.Format( _L("%d"), iIconIndex ); // bitmap index encoding; not locale specific!

        listBoxTextPtr.Append( iconIndexText );