videofeeds/vcnsuiengine/inc/vcxnscategory.h
changeset 0 96612d01cf9f
equal deleted inserted replaced
-1:000000000000 0:96612d01cf9f
       
     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 the License "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 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 #ifndef C_VCXNSVODCATEGORY_H
       
    22 #define C_VCXNSVODCATEGORY_H
       
    23 
       
    24 // INCLUDES
       
    25 #include <e32std.h>
       
    26 #include <e32base.h>
       
    27 
       
    28 // CLASS DECLARATION
       
    29 
       
    30 /**
       
    31  * Category data class.
       
    32  * Holds category information.
       
    33  * 
       
    34  * @lib vcxnsuiengine.lib
       
    35  */
       
    36 class CVcxNsCategory : public CBase
       
    37     {
       
    38 public:
       
    39 
       
    40     /**
       
    41      * Constructor.
       
    42      * @return Pointer to created CVcxNsCategory object. 
       
    43      */
       
    44     static CVcxNsCategory* NewL();
       
    45     
       
    46     /**
       
    47      * Destructor.
       
    48      */
       
    49     virtual ~CVcxNsCategory();
       
    50     
       
    51     /**
       
    52      * Get category name.
       
    53      * @return Category name.
       
    54      */
       
    55     IMPORT_C const TDesC& GetName();
       
    56 
       
    57     /**
       
    58      * Get category id
       
    59      * @return Category id
       
    60      */
       
    61     IMPORT_C TUint32 GetCategoryId();
       
    62  
       
    63     /**
       
    64      * Get category's video count.
       
    65      * @return Video count.
       
    66      */
       
    67     IMPORT_C TInt GetVideoCount();
       
    68     
       
    69     /**
       
    70      * Set category name.
       
    71      * @param aName Category name
       
    72      */
       
    73     void SetNameL( const TDesC& aName );
       
    74     
       
    75     /**
       
    76      * Set category id for category.
       
    77      * @param aCategoryId Category id.
       
    78      */
       
    79     void SetCategoryId( const TUint32 aCategoryId );
       
    80     
       
    81     /**
       
    82      * Set video count for category.
       
    83      * @param aVideoCount Video count.
       
    84      */
       
    85     void SetVideoCount( const TInt aVideoCount );
       
    86     
       
    87     /**
       
    88      * Set video count for category.
       
    89      * @param aIndex Content list highlight index
       
    90      */
       
    91     void SetHighlightContentIndex( TInt aIndex );
       
    92     
       
    93     /**
       
    94      * Get content list index for highlighting 
       
    95      * item in content list in category. 
       
    96      * @return Content list index. If not set, always 0 by default.
       
    97      */
       
    98     TInt HighlightContentIndex();
       
    99 
       
   100 private:
       
   101 
       
   102     /**
       
   103      * Default constructor
       
   104      */
       
   105     CVcxNsCategory( );
       
   106 
       
   107 private:
       
   108 
       
   109     /**
       
   110      * Category name.
       
   111      * Own.
       
   112      */
       
   113     HBufC* iName;
       
   114 
       
   115     /**
       
   116      * Category id.
       
   117      */
       
   118     TUint32 iCategoryId;
       
   119     
       
   120     /**
       
   121      * Video count in category.
       
   122      */    
       
   123     TInt iVideoCount;
       
   124     
       
   125     /**
       
   126      * Content index for category in content list.
       
   127      */ 
       
   128     TInt iContentIndex;
       
   129     
       
   130     };
       
   131 
       
   132 #endif // C_VCXNSVODCATEGORY_H