internetradio2.0/datastructuresinc/irbrowsechannelitems.h
changeset 14 896e9dbc5f19
parent 12 608f67c22514
child 15 065198191975
equal deleted inserted replaced
12:608f67c22514 14:896e9dbc5f19
     1 /*
       
     2 * Copyright (c) 2006-2007 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:  ?Description
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef IRBROWSECHANNELITEMS_H
       
    20 #define IRBROWSECHANNELITEMS_H
       
    21 
       
    22 #include <e32base.h>
       
    23 
       
    24 class RReadStream;
       
    25 class RWriteStream;
       
    26 
       
    27 /**
       
    28  * This class provides the basic structure to hold the browse information 
       
    29  *information that come from the isds server.
       
    30  *It also provides the basic getter and setter functions to 
       
    31  *manage the browse information.
       
    32  * @code
       
    33  *CIRBrowseChannelItems* browse = CIRBrowseChannelItems::NewL()
       
    34  *browse->SetXXX();
       
    35  *browse->GetXXX()
       
    36  *delete browse;
       
    37  * @endcode
       
    38  *   
       
    39  */
       
    40 class CIRBrowseChannelItems : public CBase
       
    41 	{
       
    42 public :
       
    43 
       
    44 	/**
       
    45 	*CIRBrowseChannelItems::NewLC()
       
    46 	*Static function
       
    47 	*standard two phased constructor
       
    48 	*@return CIRBrowseChannelItems*
       
    49 	*/
       
    50 	IMPORT_C	static CIRBrowseChannelItems* NewLC();
       
    51 
       
    52 	/**
       
    53 	*CIRBrowseChannelItems::NewL()
       
    54 	*Static function
       
    55 	*standard two phased constructor
       
    56 	*@return CIRBrowseChannelItems*
       
    57 	*/
       
    58 	IMPORT_C	static CIRBrowseChannelItems* NewL();
       
    59 
       
    60 	/**
       
    61 	*CIRBrowseChannelItems::ConstructL()
       
    62 	*standard two phased constructor
       
    63 	*/
       
    64 	void ConstructL() const;
       
    65 
       
    66 	/**
       
    67 	*CIRBrowseChannelItems::~CIRBrowseChannelItems()
       
    68 	*standard C++ destructor
       
    69 	*/
       
    70 	~CIRBrowseChannelItems();
       
    71 
       
    72 public:
       
    73 
       
    74 	/**
       
    75 	*CIRBrowseChannelItems::SetTextL()
       
    76 	*Set data namely channelname,channelid,description
       
    77 	*@param TDesC,TDesC,TDesC
       
    78 	*/
       
    79 	IMPORT_C	void   SetTextL(
       
    80 		const TDesC& aChannelName,const TDesC& aChannelId,const TDesC& aDescription);
       
    81 
       
    82 	/**
       
    83 	*CIRBrowseChannelItems::SetGetOperationL()
       
    84 	*Set data get methord
       
    85 	*@param TDesC
       
    86 	*/
       
    87 	IMPORT_C	void	 SetGetOperationL(const TDesC& aChannelGetOperation);
       
    88 
       
    89 	/**
       
    90 	*CIRBrowseChannelItems::SetSize()
       
    91 	*Set data size of data
       
    92 	*@param TDesC
       
    93 	*/
       
    94 	IMPORT_C	void	 SetSize(const TDesC& aSize);
       
    95 
       
    96 	/**
       
    97 	*CIRBrowseChannelItems::SetImageUrl()
       
    98 	*Set data for iImgUrl
       
    99 	*@param TDesC
       
   100 	*/
       
   101 	IMPORT_C	void	 SetImageUrl(const TDesC& aImgUrl);
       
   102 
       
   103 	/**
       
   104 	*CIRBrowseChannelItems::SetGetOperation()
       
   105 	*Set data for the get operation
       
   106 	*@param TDesC
       
   107 	*/
       
   108 	IMPORT_C	void 	 SetGetOperation(TDesC& aCatGetOperation);
       
   109 
       
   110 	/**
       
   111 	*CIRBrowseChannelItems::ExternalizeL()
       
   112 	*Externalizes data into persistent storage
       
   113 	*@param RWriteStream
       
   114 	*/
       
   115 	IMPORT_C	void   ExternalizeL(RWriteStream& aStream) const;
       
   116 
       
   117 	/**
       
   118 	*CIRBrowseChannelItems::InternalizeL()
       
   119 	*internalizes data from persistent storage
       
   120 	*@param RReadStream
       
   121 	*/
       
   122 	IMPORT_C	void   InternalizeL(RReadStream& aStream);
       
   123 
       
   124 	/**
       
   125 	*CIRBrowseChannelItems::SetLastPlayedUrl()
       
   126 	*Sets the last played url
       
   127 	*/
       
   128 	IMPORT_C	void SetLastPlayedUrl();
       
   129 
       
   130 	/**
       
   131 	*CIRBrowseChannelItems::SetBitrate()
       
   132 	*Set data for 3bitrates
       
   133 	*@param TDesC,TDesC,TDesC
       
   134 	*/
       
   135 	IMPORT_C	void SetBitrate(
       
   136 		const TDesC &aBitrate1,const TDesC &aBitrate2,const TDesC &aBitrate3);
       
   137 
       
   138 	/**
       
   139 	*CIRBrowseChannelItems::SetBitrate()
       
   140 	*Set data for 2 bitrates
       
   141 	*@param TDesC,TDesC
       
   142 	*/
       
   143 	IMPORT_C	void SetBitrate(const TDesC &aBitrate1,const TDesC &aBitrate2);
       
   144 
       
   145 	/**
       
   146 	*CIRBrowseChannelItems::SetBitrate()
       
   147 	*Set data for 1 bitrate
       
   148 	*@param TDesC
       
   149 	*/
       
   150 	IMPORT_C	void SetBitrate(const TDesC &aBitrate1);
       
   151 
       
   152 	//For Advertisements
       
   153 	/**
       
   154 	*CIRBrowseChannelItems::SetBannerUrl(const TDesC& aBannerUrl)
       
   155 	*Set data Banner Url
       
   156 	*@param TDesC
       
   157 	*/
       
   158 	IMPORT_C void SetBannerUrl(const TDesC& aBannerUrl);
       
   159 	
       
   160 	
       
   161 	/**
       
   162 	*CIRBrowseChannelItems::SetClickThroughUrl(const TDesC& aClickThroughUrl)
       
   163 	*Set data Banner Url
       
   164 	*@param TDesC
       
   165 	*/
       
   166 	IMPORT_C  void SetClickThroughUrl(const TDesC& aClickThroughUrl);
       
   167 
       
   168 public :
       
   169 	//channel name
       
   170 	HBufC*   iChannelName;
       
   171 	//short description
       
   172 	HBufC*   iShortDescription;
       
   173 	//url to fetch the preset from
       
   174 	HBufC*   iChannelGetOperation;
       
   175 	//url to fetch the image from
       
   176 	RBuf     iImgUrl;
       
   177 	//supported bitrates(were required for bitrate view)
       
   178 	//not in use now
       
   179 	TInt     iBitrate1;
       
   180 	TInt     iBitrate2;
       
   181 	TInt     iBitrate3;
       
   182 	//channel id
       
   183 	TUint    iChannelID;
       
   184 	TInt	 iSize;
       
   185 	
       
   186 	
       
   187 		//For Advertisements
       
   188 	HBufC* iBannerUrl;
       
   189 	HBufC* iClickThroughUrl;
       
   190 
       
   191 	};
       
   192 
       
   193 #endif // IRBROWSECHANNELITEMS_H