cellular/psetnotesui/inc/psuiresourceloader.h
author hgs
Wed, 21 Jul 2010 18:26:52 +0300
changeset 33 8d5d7fcf9b59
permissions -rw-r--r--
201027
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002,2003 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  Loads resources from file. 
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
#ifndef CPSUIRESOURCELOADER_H
hgs
parents:
diff changeset
    20
#define CPSUIRESOURCELOADER_H
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
//  INCLUDES
hgs
parents:
diff changeset
    23
#include <e32std.h>
hgs
parents:
diff changeset
    24
#include <e32base.h>
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
// FORWARD DECLARATIONS
hgs
parents:
diff changeset
    27
class RConeResourceLoader;
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
// CLASS DECLARATION
hgs
parents:
diff changeset
    30
/**
hgs
parents:
diff changeset
    31
* A helper class for loading dll-specific resource files on demand. 
hgs
parents:
diff changeset
    32
* Searches and loads the specified resource file to the CONE environment 
hgs
parents:
diff changeset
    33
* (CCoeEnv) -object (accessible as iCoeEnv in CONE-related classes). 
hgs
parents:
diff changeset
    34
* After calling NewL the user can access the resources directly via 
hgs
parents:
diff changeset
    35
* the CONE environment. The resources in the file are accessible until 
hgs
parents:
diff changeset
    36
* the CPsuiResourceLoader object is destroyed. The resource file must be 
hgs
parents:
diff changeset
    37
* a well-formed UIKON resource file with NAME and RSS_SIGNATURE specified.
hgs
parents:
diff changeset
    38
*
hgs
parents:
diff changeset
    39
* @lib psui.lib
hgs
parents:
diff changeset
    40
* @since 1.0
hgs
parents:
diff changeset
    41
*/
hgs
parents:
diff changeset
    42
class CPsuiResourceLoader : public CBase
hgs
parents:
diff changeset
    43
    {
hgs
parents:
diff changeset
    44
    public:  // Constructors & destructor
hgs
parents:
diff changeset
    45
hgs
parents:
diff changeset
    46
         /**
hgs
parents:
diff changeset
    47
         * Symbian OS 1st phase constructor. Creates and returns a new
hgs
parents:
diff changeset
    48
         * resource loader object. 
hgs
parents:
diff changeset
    49
         * Loads resource from any drive. If this function is succesful
hgs
parents:
diff changeset
    50
         * (doesn't leave) the resources in the file are usable through
hgs
parents:
diff changeset
    51
         * CCoeEnv.
hgs
parents:
diff changeset
    52
         * 
hgs
parents:
diff changeset
    53
         * @return new object of this class holding a reference to the
hgs
parents:
diff changeset
    54
         *                      resource file.
hgs
parents:
diff changeset
    55
         *
hgs
parents:
diff changeset
    56
         * @exception KErrNotFound  if the resource file is not found.
hgs
parents:
diff changeset
    57
         * @exception KErrNoMemory  if out of memory.
hgs
parents:
diff changeset
    58
         * @exception error         from CCoeEnv::AddResourceFileL.
hgs
parents:
diff changeset
    59
         */
hgs
parents:
diff changeset
    60
        IMPORT_C static CPsuiResourceLoader* NewL();
hgs
parents:
diff changeset
    61
hgs
parents:
diff changeset
    62
         /**
hgs
parents:
diff changeset
    63
         * Same as NewL, but leaves the created object onto the cleanup stack.
hgs
parents:
diff changeset
    64
         * @see NewL
hgs
parents:
diff changeset
    65
         */
hgs
parents:
diff changeset
    66
        IMPORT_C static CPsuiResourceLoader* NewLC();
hgs
parents:
diff changeset
    67
hgs
parents:
diff changeset
    68
         /* Destructor */
hgs
parents:
diff changeset
    69
        ~CPsuiResourceLoader();
hgs
parents:
diff changeset
    70
hgs
parents:
diff changeset
    71
    protected:  // private constructor
hgs
parents:
diff changeset
    72
hgs
parents:
diff changeset
    73
        void ConstructL();
hgs
parents:
diff changeset
    74
hgs
parents:
diff changeset
    75
    private:  // member variables
hgs
parents:
diff changeset
    76
hgs
parents:
diff changeset
    77
        // CONE resource loader
hgs
parents:
diff changeset
    78
        RConeResourceLoader* iResourceLoader;
hgs
parents:
diff changeset
    79
    };
hgs
parents:
diff changeset
    80
hgs
parents:
diff changeset
    81
#endif  // CPSUIRESOURCELOADER_H
hgs
parents:
diff changeset
    82
hgs
parents:
diff changeset
    83
// End of File
hgs
parents:
diff changeset
    84