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