homescreenpluginsrv/inc/hspspluginidlist.h
branchRCL_3
changeset 114 a5a39a295112
parent 0 79c6a41cd166
equal deleted inserted replaced
113:0efa10d348c0 114:a5a39a295112
       
     1 /*
       
     2 * Copyright (c) 2008 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 "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  
       
    15 *
       
    16 *  HSPS ChspsPluginIdList-class defines all information what is needed to maintain
       
    17 *  resources of Application Theme. Every ChspsPluginIdList-objects defines just one 
       
    18 *  resource source, however, the same resource source could be referenced
       
    19 *  multiple times inside a theme - resources are usually shared. 
       
    20 *  HSPS Application Theme Management system supports theme resourcing by 
       
    21 *  offering resource conversations and storing services, and offering Rendering
       
    22 *  Engines the following services:
       
    23 *  1) the way to match a resource quoted in xml- or css-module to the 
       
    24 *  corresponding resource source, and 2) a secure way to access a resource 
       
    25 *  through the Symbian Platform Security's process separation wall.
       
    26 *
       
    27 *
       
    28 */
       
    29 
       
    30 
       
    31 #ifndef hspsPLUGINIDLIST_H
       
    32 #define hspsPLUGINIDLIST_H
       
    33 
       
    34 #include <e32base.h>
       
    35 #include <s32mem.h> // streams
       
    36 
       
    37 /**
       
    38 *  ChspsPluginIdList is HSPS-utility class for passing IPC data 
       
    39 *
       
    40 *  @lib hspsResource.lib
       
    41 *  @since S60 5.0
       
    42 *  @ingroup group_hspsresult
       
    43 */
       
    44 class ChspsPluginIdList : public CArrayFixFlat<TInt>
       
    45     {
       
    46     public:  // Constructors and destructor
       
    47                             
       
    48     	/**
       
    49         * C++ default constructor.
       
    50         * 
       
    51         * @since S60 5.0
       
    52         * @param aGranularity List granularity.
       
    53         */
       
    54     	IMPORT_C ChspsPluginIdList( TInt aGranularity );
       
    55     	    	
       
    56         /**
       
    57         * Destructor.
       
    58         */
       
    59     	IMPORT_C virtual ~ChspsPluginIdList();
       
    60 
       
    61     public: // New functions
       
    62                         
       
    63         /**
       
    64         * Externalizes ChspsResource-object's member data.
       
    65         * 
       
    66         * @since S60 5.0
       
    67         * @param aStream is a write stream given.
       
    68         */
       
    69         IMPORT_C void ExternalizeL( RDesWriteStream& aStream ) const;
       
    70         
       
    71         /**
       
    72         * Internalizes ChspsResource-object's member data.
       
    73         * 
       
    74         * @since S60 5.0
       
    75         * @param aStream is data read stream given.
       
    76         */
       
    77         IMPORT_C void InternalizeL( RDesReadStream& aStream );
       
    78         
       
    79         /**
       
    80         * Calculates data length of the ChspsPluginIdList object.
       
    81         * 
       
    82         * @since S60 5.0
       
    83         * @return Data length.
       
    84         */
       
    85         IMPORT_C TInt GetDataLength();
       
    86                                    
       
    87     private:     // Data
       
    88     	
       
    89     };
       
    90 
       
    91 #endif      // hspsPLUGINIDLIST_H
       
    92 
       
    93 // End of File