idlehomescreen/sapiwrapper/hspswrapper/inc/objectmap.h
author Simon Howkins <simonh@symbian.org>
Tue, 16 Nov 2010 11:12:20 +0000
branchRCL_3
changeset 108 cf9be2d674f1
parent 0 f72a12da539e
permissions -rw-r--r--
Fixed path to files to be exported

/*
* Copyright (c) 2008 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:  Presents object map as name, path and mediatype data  
*
*/



#ifndef C_COBJECTMAP_H
#define C_COBJECTMAP_H


#include <e32base.h>

namespace hspswrapper{


/**
 *  Presents object map as name, path and mediatype data 
 *  
 *
 *  @code
 *  @endcode
 *
 *  @lib xnlayoutengine.lib
 *  @since S60 v5.0
 */
class CObjectMap : public CBase
    {
public:    
    /**
     * Two-phased constructor.
     */
    IMPORT_C static CObjectMap* NewL();
    IMPORT_C static CObjectMap* NewLC();
    

    /**
    * Destructor.
    */
    IMPORT_C virtual ~CObjectMap();

    /**
     * Set object name
     *
     * @param aName object name
     * @return Reference to this object
     */
    IMPORT_C CObjectMap& SetNameL( const TDesC8& aName );
    
    /**
     * Get object name
     *
     * @return Reference to name or KNullDesC8
     */
    IMPORT_C const TDesC8& NameL()const;
    
    /**
     * Set object path
     *
     * @param aPath object path
     * @return Reference to this object
     */
    IMPORT_C CObjectMap& SetPathL( const TDesC8& aPath );
    
    /**
     * Get object path
     *
     * @return Reference to path or KNullDesC8
     */
    IMPORT_C const TDesC8& Path()const;
    
    /**
     * Set object media type
     *
     * @param aMediaType object media type
     * @return Reference to this object
     */
    IMPORT_C CObjectMap& SetMediaTypeL( const TDesC8& aMediaType );
    
    /**
     * Get object media type
     *
     * @return Reference to media type or KNullDesC8
     */
    IMPORT_C const TDesC8& MediaType()const;
    
    /**
     * Set object tag
     *
     * @param aTag object tag
     * @return Reference to this object
     */
    IMPORT_C CObjectMap& SetTagL( const TDesC8& aTag );
    
    /**
     * Get object tag
     *
     * @return Reference to tag or KNullDesC8
     */
    IMPORT_C const TDesC8& Tag()const; 

private:
    CObjectMap();

    void ConstructL();

private: // data

    /**
     * Own. Object name
     */
    HBufC8* iName;
    
    /**
     * Own. Object path
     */
    HBufC8* iPath;
    
    /**
     * Own. Object mediatype
     */
    HBufC8* iMediaType;
    
    /**
     * Own. Object tag
     */
    HBufC8* iTag;
    };

}
#endif // C_COBJECTMAP_H