epoc32/include/app/rpbkviewresourcefile.h
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
     1.1 --- a/epoc32/include/app/rpbkviewresourcefile.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/app/rpbkviewresourcefile.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,69 @@
     1.4 -rpbkviewresourcefile.h
     1.5 +/*
     1.6 +* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* 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
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description: 
    1.19 +*     Helper class for loading PbkView resources.
    1.20 +*
    1.21 +*/
    1.22 +
    1.23 +
    1.24 +#ifndef __RPbkViewResourceFile_H__
    1.25 +#define __RPbkViewResourceFile_H__
    1.26 +
    1.27 +//  INCLUDES
    1.28 +#include <e32std.h>
    1.29 +#include "ConeResLoader.h"
    1.30 +
    1.31 +// CLASS DECLARATION
    1.32 +
    1.33 +/**
    1.34 + * Helper class for loading the PbkView DLL resource file.
    1.35 + */
    1.36 +class RPbkViewResourceFile
    1.37 +    {
    1.38 +    public:  // Interface
    1.39 +        /**
    1.40 +         * Constructor.
    1.41 +         * @param aEnv CONE environment where to load the resource file.
    1.42 +         */
    1.43 +        IMPORT_C RPbkViewResourceFile(CCoeEnv& aEnv);
    1.44 +
    1.45 +        /**
    1.46 +         * Opens the PbkView dll resource file for use. Leaves if the
    1.47 +         * resource file is already open.
    1.48 +         */
    1.49 +        IMPORT_C void OpenL();
    1.50 +
    1.51 +        /**
    1.52 +         * Returns ETrue if the resource file is open.
    1.53 +         * @return ETrue if the resource file is open.
    1.54 +         */
    1.55 +        IMPORT_C TBool IsOpen() const;
    1.56 +    
    1.57 +        /**
    1.58 +         * Closes the PbkView dll resource file.
    1.59 +         * You must always remember to close the resource file when finished 
    1.60 +         * using it.
    1.61 +         */
    1.62 +        IMPORT_C void Close();
    1.63 +
    1.64 +    private:  // Data
    1.65 +		/// Own: resource loader
    1.66 +        RConeResourceLoader iLoader;
    1.67 +		/// Own: file open flag
    1.68 +        TBool iOpen;
    1.69 +    };
    1.70 +
    1.71 +#endif // __RPbkViewResourceFile_H__
    1.72 +
    1.73 +// End of File