epoc32/include/app/rpbkviewresourcefile.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description: 
williamr@2
    15
*     Helper class for loading PbkView resources.
williamr@2
    16
*
williamr@2
    17
*/
williamr@2
    18
williamr@2
    19
williamr@2
    20
#ifndef __RPbkViewResourceFile_H__
williamr@2
    21
#define __RPbkViewResourceFile_H__
williamr@2
    22
williamr@2
    23
//  INCLUDES
williamr@2
    24
#include <e32std.h>
williamr@2
    25
#include "ConeResLoader.h"
williamr@2
    26
williamr@2
    27
// CLASS DECLARATION
williamr@2
    28
williamr@2
    29
/**
williamr@2
    30
 * Helper class for loading the PbkView DLL resource file.
williamr@2
    31
 */
williamr@2
    32
class RPbkViewResourceFile
williamr@2
    33
    {
williamr@2
    34
    public:  // Interface
williamr@2
    35
        /**
williamr@2
    36
         * Constructor.
williamr@2
    37
         * @param aEnv CONE environment where to load the resource file.
williamr@2
    38
         */
williamr@2
    39
        IMPORT_C RPbkViewResourceFile(CCoeEnv& aEnv);
williamr@2
    40
williamr@2
    41
        /**
williamr@2
    42
         * Opens the PbkView dll resource file for use. Leaves if the
williamr@2
    43
         * resource file is already open.
williamr@2
    44
         */
williamr@2
    45
        IMPORT_C void OpenL();
williamr@2
    46
williamr@2
    47
        /**
williamr@2
    48
         * Returns ETrue if the resource file is open.
williamr@2
    49
         * @return ETrue if the resource file is open.
williamr@2
    50
         */
williamr@2
    51
        IMPORT_C TBool IsOpen() const;
williamr@2
    52
    
williamr@2
    53
        /**
williamr@2
    54
         * Closes the PbkView dll resource file.
williamr@2
    55
         * You must always remember to close the resource file when finished 
williamr@2
    56
         * using it.
williamr@2
    57
         */
williamr@2
    58
        IMPORT_C void Close();
williamr@2
    59
williamr@2
    60
    private:  // Data
williamr@2
    61
		/// Own: resource loader
williamr@2
    62
        RConeResourceLoader iLoader;
williamr@2
    63
		/// Own: file open flag
williamr@2
    64
        TBool iOpen;
williamr@2
    65
    };
williamr@2
    66
williamr@2
    67
#endif // __RPbkViewResourceFile_H__
williamr@2
    68
williamr@2
    69
// End of File