photosgallery/viewframework/commandhandlers/commoncommandhandlers/inc/glxaiwmedia.h
changeset 0 4e91876724a2
equal deleted inserted replaced
-1:000000000000 0:4e91876724a2
       
     1 /*
       
     2 * Copyright (c) 2008-2009 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:    Photos AIW Media Contains AIW (InParam) information
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 #ifndef _GLXAIWMEDIA_H
       
    22 #define _GLXAIWMEDIA_H
       
    23 
       
    24 /**
       
    25  * CGlxAiwMedia
       
    26  * Class to store AIW parameters for a given TGlxMediaId
       
    27  *
       
    28  * @author Rowland Cook
       
    29  */
       
    30 
       
    31 #include <e32base.h>
       
    32 #include "glxmediaid.h"
       
    33 
       
    34 
       
    35 /**
       
    36  * Forward references
       
    37  */
       
    38 
       
    39 class TAiwGenericParam;
       
    40 class TGlxMediaId;
       
    41 
       
    42 /**
       
    43  *  CGlxAiwMedia class
       
    44  *  This class contains an array AIW parameters for a given media item.
       
    45  */
       
    46 NONSHARABLE_CLASS(CGlxAiwMedia) : public CBase
       
    47     {
       
    48 public:
       
    49     /**
       
    50      *  Constructor
       
    51      *  @param TGlxMediaId of the Media Item
       
    52      */
       
    53     CGlxAiwMedia(const TGlxMediaId& aId);
       
    54 
       
    55     /**
       
    56      *  Destructor
       
    57      */
       
    58     virtual ~CGlxAiwMedia();
       
    59     
       
    60     /**
       
    61      *  AddParamL
       
    62      *  @param TAiwGenericParam& The AIW parameter that needs to be added to the
       
    63      *  array. This is only added if the paramter does not already exist.
       
    64      *  @return ETrue if added, EFalse if already exists
       
    65      */
       
    66     TBool AddParamL(const TAiwGenericParam& aParam);
       
    67     
       
    68     /**
       
    69      *  Id
       
    70      *  @return a reference to the TGlxMediaId of the item
       
    71      */
       
    72     const TGlxMediaId& Id() const;
       
    73     
       
    74     /**
       
    75      * Appends all the parameters in the iParamArray to aInParams.
       
    76      * @param aInParams reference to the InParams that is added too.
       
    77      */
       
    78      void AppendToInParamsL(CAiwGenericParamList& aInParams);
       
    79 
       
    80 private:
       
    81 
       
    82     // The TGlxMediaId of the item associated with this class.
       
    83     TGlxMediaId                 iId;
       
    84     
       
    85     // The array of TAiwGenericParam that is associated with the TGlxMediaId (iId).
       
    86     RArray<TAiwGenericParam>    iParamArray;
       
    87     };
       
    88 
       
    89 #endif