/*

* Copyright (c) 2007 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:  Decleares base dialog controlling functionality.

*

*/

#ifndef IPSSETUIBASEDIALOG_H

#define IPSSETUIBASEDIALOG_H

#include <eiklbo.h>                 // MEikListBoxObserver

#include <coedef.h>                 // TKeyResponse

#include <w32std.h>                 // TKeyEvent

#include <eikcmobs.h>               // MEikCommandObserver

#include <aknsettingpage.h>         // MAknSettingPageObserver

#include "ipssetuibasearray.h"

#include "ipssetuictrlpageresource.h"

typedef CArrayFixFlat<TInt> CIpsSetUiIntArray;

typedef CArrayPtrFlat<CAknSettingPage> CIpsSetUiPages;

typedef CAknSettingPage::TAknSettingPageUpdateMode TIpsSetUiUpdateMode;

class CEikFormattedCellListBox;

class CEikScrollBarFrame;

class CAknSettingPage;

class CAknTitlePane;

class CAknQueryDialog;

class CEikButtonGroupContainer;

class CSelectionItemList;

class CIpsSetUiApprover;

class CIpsSetUiItem;

class CIpsSetUiCtrlSoftkey;

/**

 * Base dialog control functionality.

 *

 * @since FS v1.0

 * @lib IpsSosSettings.lib

 */

class CIpsSetUiBaseDialog :

    public CIpsSetUiBaseArray,

    public MEikListBoxObserver,

    public MEikCommandObserver,

    public MAknSettingPageObserver

    {

public: // Constructors and destructor

    /**

     * Destructor.

     */

    virtual ~CIpsSetUiBaseDialog();

public: // New virtual functions

    /**

     * Setting has started.

     *

     * @return ETrue, when continue is ok.

     */

    virtual TBool SettingsStartedL();

public: // New functions

    /**

     * @return Currently active item.

     */

    TInt CurrentItemIndex() const;

    /**

     * @return Currently focused item.

     */

    CIpsSetUiItem* CurrentItem() const;

    //<cmail>

    /**

     * Count of list box items

     * 

     * @return count of list box items

     */

    TInt CountInListBox() const;

    //</cmail>

protected:  // Constructors

    /**

     * Constructor.

     *

     * @param aListBox Listbox owned by the dialog.

     * @param aTitlePane Just take a wild guess.

     */

    CIpsSetUiBaseDialog(

        CEikFormattedCellListBox& aListBox,

        CAknTitlePane& aTitlePane );

    /**

     * 2nd phase of constuction

     *

     * @param aButtons Buttons owned by the dialog.

     * @param aResource Settings resource.

     * @param aUpdateMSK Middle softkey support.

     */

    void ConstructL(

        CEikButtonGroupContainer& aButtons,

        const TInt aResource = NULL,

        const TBool aUpdateMSK = EFalse );

protected:  // New virtual functions

// From MAknSettingPageObserver

    /**

     * Handle event invoked by the setting page.

     *

     * @param aSettingPage SettingPage that invoked the event.

     * @param aEventType Type of invoked event.

     */

    virtual void HandleSettingPageEventL(

        CAknSettingPage* aSettingPage,

        TAknSettingPageEvent aEventType ) = 0;

    /**

     * Check if the exiting is ok.

     *

     * @param aButtonId Button that is pressed.

     * @return ETrue, when exit is ok.

     */

    virtual TBool OkToExitL(

        const TInt aButtonId ) = 0;

    /**

     * Initializes undefined item.

     *

     * @param aBaseItem Item to be initialized.

     * @param aValue Value to be used in initialization.

     * @param aText Text to be used in initialization.

     * @return KErrNone, when init is success.

     */

    virtual TInt InitItemUnidentified(

        CIpsSetUiItem& aBaseItem,

        const TInt aValue,

        const TDesC& aText );

    /**

     * Launch multiline editor.

     *

     * @param aBaseItem Preferably multiline editor item.

     * @param aUpdateMode Mode to be used to launch the editor.

     * @return Result of the edit.

     */

    virtual TIpsSetUiEventResult SettingLaunchMultilineEditorL(

        CIpsSetUiItem& aBaseItem,

        TIpsSetUiUpdateMode& aUpdateMode );

    /**

     * Key event catcher.

     *

     * @param aKeyEvent Invoked key event.

     * @param aType Type of the event.

     * @return Consumed/Not consumed.

     */

    virtual TKeyResponse OfferKeyEventL(

        const TKeyEvent& aKeyEvent,

        TEventCode aType );

    /**

     * Get unique setting page.

     *

     * @param aReturnPage Page to be created.

     * @param aReturnUpdateMode Update mode of the page.

     * @param aReturnSettingValue User input value.

     * @param aReturnSettingText User input text.

     * @param aRetrunRadioButtonArray Custom array of buttons.

     * @param aParamBaseItem Item invoked the event.

     */

    virtual void AcquireCustomSettingPageL(

        CAknSettingPage*& aReturnPage,

        TIpsSetUiUpdateMode& aReturnUpdateMode,

        TInt& aReturnSettingValue,

        TDes& aReturnSettingText,

        CDesCArrayFlat& aReturnRadioButtonArray,

        CIpsSetUiItem& aParamBaseItem );

    /**

     *

     *

     * @param aBaseItem Item invoked the event.

     */

    virtual TInt EventSubArrayChangeL(

        CIpsSetUiItem& aBaseItem );

    /**

     *

     *

     * @param aBaseItem Item invoked the event.

     */

    virtual TIpsSetUiEventResult EventItemEditStartsL(

        CIpsSetUiItem& aBaseItem );

    /**

     *

     *

     * @param aBaseItem Item invoked the event.

     */

    virtual TInt EventItemEditEndsL(

        CIpsSetUiItem& aBaseItem );

    /**

     *

     *

     * @param aBaseItem Item invoked the event.

     */

    virtual TIpsSetUiEventResult EventItemEvaluateValue(

        const CIpsSetUiItem& aBaseItem,

        TInt& aNewValue );

    /**

     * Checks user input.

     *

     * @param aBaseItem Item invoked the event.

     * @param aNewValue User input value.

     */

    virtual TIpsSetUiEventResult EventItemEvaluateRadioButton(

        const CIpsSetUiItem& aBaseItem,

        TInt& aNewValue );

    /**

     * Checks user input.

     *

     * @param aBaseItem Item invoked the event.

     * @param aNewText User input text.

     */

    virtual TIpsSetUiEventResult EventItemEvaluateText(

        const CIpsSetUiItem& aBaseItem,

        TDes& aNewText );

protected:  // New functions

    // Setting page opening

    /**

     *

     *

     * @param .

     * @return .

     */

    TIpsSetUiPageResult OpenSettingPageL(

        const TInt aIndex = KErrNotFound );

    /**

     *

     *

     * @param .

     * @return .

     */

    TIpsSetUiPageResult OpenSettingPageL(

        CIpsSetUiItem& aBaseItem );

    /**

     *

     *

     * @param .

     * @param .

     */

    void SetMainMBoxMenuTitlePaneTextL(

        const TDesC& aText,

        const TBool aSaveCurrent = ETrue );

    /**

     *

     *

     * @param .

     */

    void SetSettingsMenuTitlePaneText(

        const TBool aSaveCurrent = ETrue );

    /**

     *

     *

     * @param .

     * @param .

     * @param .

     * @return .

     */

    CIpsSetUiItem* SettingFindEditor(

        const CIpsSetUiItem& aBaseItem,

        const TInt aIndex,

        const TBool aExcludeHidden = ETrue );

    /**

     *

     *

     * @param .

     * @param .

     * @param .

     * @return .

     */

    CIpsSetUiItem* SettingFindEditor(

        const CIpsSetUiItem& aBaseItem,

        const TUid& aId,

        const TBool aExcludeHidden = ETrue );

    /**

     *

     *

     * @param .

     * @param .

     * @param .

     * @return .

     */

    TInt InitAnyItem(

        CIpsSetUiItem& aBaseItem,

        const TInt aValue,

        const TDesC& aText );

    /**

     *

     *

     * @param .

     * @return .

     */

    TInt ShowCustomQueryL(

        const TInt aResourceStringId );

    /**

     *

     *

     * @param .

     * @return .

     */

    TInt GetTextEditorFlags( const CIpsSetUiItem& aBaseItem );

    /**

     *

     *

     * @param .

     * @return .

     */

    TInt GetValueEditorFlags( const CIpsSetUiItem& aBaseItem );

    /**

     *

     *

     * @param .

     */

    void SetListboxEmptyTextL( const TDesC& aText );

    /**

     * Gets the setting page resource of specific item

     *

     * @param .

     * @return resource id of the page

     */

    TInt SettingPageResource(

        const TIpsSetUiPageResource aSettingPage ) const;

    /**

     * Sets the new setting page resource for specific item

     *

     * @param aSettingPage Inserts the resource for the page

     * @param .

     */

    void SetSettingPageResource(

        const TIpsSetUiPageResource aSettingPage,

        const TInt aResourceId );

    /**

     *

     *

     * @param .

     * @param .

     */

    void CheckRadioButton(

        CIpsSetUiItemLink& aRadioButtonArray,

        const TInt aRadioButtonIndex );

    /**

     *

     *

     * @param .

     * @param .

     */

    void CheckRadioButton(

        CIpsSetUiItemLink& aRadioButtonArray,

        const TUid& aId );

    /**

     *

     *

     * @param .

     * @param .

     * @param .

     * @return .

     */

     TInt FindCheckedRadiobutton(

        const CIpsSetUiItemLinkExt& aArray,

        TUid& aId,

        TInt& aIndex );

    /**

     *

     *

     * @param .

     */

    void AddBackupItemL(

        const CIpsSetUiItem& aBaseItem );

    /**

     *

     *

     */

    void RemoveLastBackupItem();

    /**

     *

     *

     * @return .

     */

    CIpsSetUiItem* GetLastBackupItem();

    /**

     *

     *

     */

    void RestoreFromBackup();

    /**

     *

     *

     */

    void CleanBackupArray();

protected:  // Functions from base classes

    // MEikCommandObserver

    /**

     *

     *

     * @param .

     */

    virtual void ProcessCommandL( TInt aCommandId ) = 0;

private:  // New functions

    // Setting page opening

    /**

     *

     *

     * @return .

     */

    TIpsSetUiPageResult SettingsPageOpenCheckL();

    /**

     *

     *

     * @return .

     */

    TIpsSetUiPageResult SettingPageOpenEditorL();

    /**

     *

     *

     */

    void SettingPageOpenFinishL();

    /**

     *

     *

     * @param .

     * @return .

     */

    TIpsSetUiPageResult SettingPageOpenL(

        CIpsSetUiItem& aBaseItem );

    /**

     * Launches setting page.

     *

     * @param aBaseItem Item to be edited by the UI.

     * @param aUpdateMode Mode of the editor.

     * @return Result of the edit operation.

     */

    TIpsSetUiPageResult SettingLaunchPageLD(

        CIpsSetUiItem& aBaseItem,

        TIpsSetUiUpdateMode& aUpdateMode );

    /**

     * Launches setting page.

     *

     * @param aBaseItem Item to be edited by the UI.

     * @param aUpdateMode Mode of the editor.

     * @return Result of the edit operation.

     */

    TIpsSetUiPageResult SettingLaunchRadioButtonPageLD(

        CIpsSetUiItem& aBaseItem,

        TIpsSetUiUpdateMode& aUpdateMode );

    /**

     * Launches setting page.

     *

     * @param aBaseItem Item to be edited by the UI.

     * @param aUpdateMode Mode of the editor.

     * @return Result of the edit operation.

     */

    TIpsSetUiPageResult SettingLaunchCheckboxPageLD(

        CIpsSetUiItem& aBaseItem,

        TIpsSetUiUpdateMode& aUpdateMode );

    /**

     * Launches setting page.

     *

     * @param aBaseItem Item to be edited by the UI.