/*

* Copyright (c) 2002-2006 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:  Base class for Common File Dialogs.

*

*/

#ifndef CAKNCOMMONDIALOGSBASE_H

#define CAKNCOMMONDIALOGSBASE_H

// INCLUDES

#include <e32base.h>

#include <ConeResLoader.h>

// CONSTANTS

/**

* Enumerations for different dialogs. A dialog loads its default values

* (such as softkey texts and title) depending on its type.

*/

enum TCommonDialogType

    {

    ECFDDialogTypeNormal,

    ECFDDialogTypeSelect,

    ECFDDialogTypeSave,

    ECFDDialogTypeMove,

    ECFDDialogTypeBrowse,

    ECFDDialogTypeDefaultSetting, //Cannot be used in multi-drive

    ECFDDialogTypeCopy

    };

/**

* Text that is shown when Common File Dialogs panics.

*/

_LIT( KCFDPanicText, "CommonDialogs" );

/**

* Enumerations for Common File Dialog panics.

*/

enum TCFDPanics

    {

    ECFDPanicInvalidFilterType                      =  1,

    ECFDPanicInvalidFilterStyle                     =  2,

    ECFDPanicInvalidAttributeFilterDataLength       =  3,

    ECFDPanicInvalidAttributeFilterDataCount        =  4,

    ECFDPanicInvalidFileNameFilterDataLength        =  5,

    ECFDPanicInvalidFileNameFilterDataCount         =  6,

    ECFDPanicNoLocationStructures                   =  7,

    ECFDPanicRootPathNotDefined                     =  8,

    ECFDPanicNoPathForFileNamePromptDialog          =  9,

    ECFDPanicOutOfBounds                            = 10,

    ECFDPanicNullParameter                          = 11,

    ECFDPanicNoResourceDefined                      = 12,

    ECFDPanicTitleOrSoftkeyNotSet                   = 13

    };

// FORWARD DECLARATIONS

class CCoeEnv;

//  CLASS DEFINITION

/**

*  Base class for Common File Dialogs.

*  Can't be created without derivation because of the protected constructor.

*  Opens CFD's resource in BaseConstructL.

*

*  @lib CommonDialogs.lib

*  @since 1.2

*/

NONSHARABLE_CLASS(CAknCommonDialogsBase) : public CBase

    {

    public:     // Enumerations

        /**

        * Sometimes it is necessary to know if dialog was exited by

        * left softkey or selection key. This enumeration works as TBool,

        * ERightSoftkey is not true and other return values are.

        * For example, memory selection dialog and file selection dialog

        * return values of this enumeration.

        */

        enum TReturnKey

            {

            ERightSoftkey = EFalse,

            ELeftSoftkey,

            ESelectionKey

            };

    protected:  // Constructors and destructors

        CAknCommonDialogsBase();

        virtual ~CAknCommonDialogsBase();

        /**

        * Loads resource of Common File Dialogs on any language.

        */

        void BaseConstructL();

    protected:  // Data

        /**

        * Ref: Pointer to control environment.

        * Pointer is cached because using of CCoeEnv::Static() is slow.

        * For direct use for derived classes.

        */

        CCoeEnv* iCoeEnv;

    private:    // Data

        // Own: Loads resource file of Common File Dialogs on any language.

        RConeResourceLoader iResourceLoader;

    };

#endif // CAKNCOMMONDIALOGSBASE_H

// End of File