homescreensrv_plat/hs_content_control_api/inc/hscontentinfoarray.h
branchRCL_3
changeset 78 1b207dd38b72
parent 0 79c6a41cd166
equal deleted inserted replaced
74:edd621764147 78:1b207dd38b72
     1 /*
     1 /*
     2 * Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
     2 * Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     4 * This component and the accompanying materials are made available
     5 * under the terms of "Eclipse Public License v1.0"
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
    28 class CHsContentInfo;
    28 class CHsContentInfo;
    29 
    29 
    30 /**
    30 /**
    31  *  Content data
    31  *  Content data
    32  *
    32  *
    33  *
    33  *  @lib hscontentinfo.lib
    34  *  @code
    34  *  @since S60 v5.2
    35  *
       
    36  *  @endcode
       
    37  *
       
    38  *  @lib hscontentcontrol.lib
       
    39  *  @since S60 v5.0
       
    40  */
    35  */
    41 class CHsContentInfoArray : public CBase
    36 class CHsContentInfoArray : public CBase
    42     {
    37     {
    43     public:
    38     public:
    44     /**
    39     /**
    45      * Two-phased constructor.
    40      * Two-phased constructor.
       
    41      *
       
    42      * @since S60 v5.2
    46      */
    43      */
    47     IMPORT_C static CHsContentInfoArray* NewL();
    44     IMPORT_C static CHsContentInfoArray* NewL();
    48     
    45     
    49     /**
    46     /**
    50      * Two-phased constructor.
    47      * Two-phased constructor.
       
    48      *
       
    49      * @since S60 v5.2
    51      */
    50      */
    52     IMPORT_C static CHsContentInfoArray* NewL( RReadStream& aStream );    
    51     IMPORT_C static CHsContentInfoArray* NewL( RReadStream& aStream );    
    53 
    52 
    54     /**
    53     /**
    55      * Destructor.
    54      * Destructor.
       
    55      *
       
    56      * @since S60 v5.2
    56      */
    57      */
    57     virtual ~CHsContentInfoArray();
    58     virtual ~CHsContentInfoArray();
    58     
    59     
    59     /**
    60     /**
    60      * Externalizes the array into the stream.
    61      * Externalizes the array into the stream.
       
    62      *
       
    63      * @since S60 v5.2
    61      */
    64      */
    62     IMPORT_C void ExternalizeL( RWriteStream& aStream );
    65     IMPORT_C void ExternalizeL( RWriteStream& aStream );
    63     
    66     
       
    67     /**
       
    68      * Returns reference to content info array
       
    69      *
       
    70      * @since S60 v5.2
       
    71      * @return Content info array
       
    72      */
    64     IMPORT_C RPointerArray< CHsContentInfo >& Array();
    73     IMPORT_C RPointerArray< CHsContentInfo >& Array();
    65 
    74 
    66     /**
    75     /**
    67      * Internalizes the array from the stream.
    76      * Internalizes the array from the stream.
       
    77      *
       
    78      * @since S60 v5.2
    68      */
    79      */
    69     IMPORT_C void InternalizeL( RReadStream& aStream );
    80     IMPORT_C void InternalizeL( RReadStream& aStream );
    70     
    81     
    71     /**
    82     /**
    72      * Returns size of a descriptor needed to externalize the class
    83      * Returns size of a descriptor needed to externalize the class
       
    84      *
       
    85      * @since S60 v5.2
    73      */
    86      */
    74     IMPORT_C TInt Size();
    87     IMPORT_C TInt Size();
    75 
    88 
    76     /**
    89     /**
    77      * Marshals Content Info array to a descriptor
    90      * Marshals Content Info array to a descriptor
    78      * 
    91      * 
    79      * @since S60 5.0
    92      * @since S60 5.2
    80      * @return Descriptor containing the externalized Content Info array data
    93      * @return Descriptor containing the externalized Content Info array data
    81      */
    94      */
    82     IMPORT_C HBufC8* MarshalL();
    95     IMPORT_C HBufC8* MarshalL();
    83 
    96 
    84 private:
    97 private: