FavouritesItem.h

00001 /*
00002 * ==============================================================================
00003 *  Name        : FavouritesItem.h 
00004 *  Part of     : Favourites Engine
00005 *  Interface   : Favourites Engine API
00006 *  Description : Declaration of FavouritesItem
00007 *  Version     : %Version%
00008 *
00009 *  Copyright (C) 2004 Nokia Corporation.
00010 *  This material, including documentation and any related 
00011 *  computer programs, is protected by copyright controlled by 
00012 *  Nokia Corporation. All rights are reserved. Copying, 
00013 *  including reproducing, storing,  adapting or translating, any 
00014 *  or all of this material requires the prior written consent of 
00015 *  Nokia Corporation. This material also contains confidential 
00016 *  information which may not be disclosed to others without the 
00017 *  prior written consent of Nokia Corporation.
00018 *
00019 * ============================================================================
00020 */
00022 #ifndef FAVOURITES_ITEM_H
00023 #define FAVOURITES_ITEM_H
00024 
00025 //  INCLUDES
00027 #include <e32base.h>
00028 #include <FavouritesLimits.h>
00029 #include <FavouritesWapAp.h>
00031 // FORWARD DECLARATION
00033 class CFavouritesItemImpl;
00034 class RWriteStream;
00035 class RReadStream;
00037 // CLASS DECLARATION
00044 class CFavouritesItem: public CBase
00045     {
00047     public:     // Data types
00052         enum TType  
00053             {
00054            /*
00055             * Invalid value, can not be set for a CFavouritesItem 
00056             * @see For more informaiton on ENone, see CFavouritesItem.
00057             */
ENone,  
00059            /*
00060             * Favourites item
00061             * @see For more informaiton on ENone, see CFavouritesItem.
00062             */            
EItem,  
00064            /*
00065             * Favourites folder.
00066             * @see For more informaiton on ENone, see CFavouritesItem.
00067             */
EFolder 
00069             };
00071     public:     // Constructors and destructor
00079         IMPORT_C static CFavouritesItem* NewLC();
00086         IMPORT_C static CFavouritesItem* NewL();
00092         IMPORT_C virtual ~CFavouritesItem();
00099         IMPORT_C CFavouritesItem& operator=
00100             ( const CFavouritesItem& aCopyFrom );
00102     public:     // Query
00109         IMPORT_C TInt Uid() const;
00116         IMPORT_C TInt ParentFolder() const;
00125         IMPORT_C TType Type() const;
00132         IMPORT_C const TPtrC Name() const;
00139         IMPORT_C const TPtrC Url() const;
00146         IMPORT_C TFavouritesWapAp WapAp() const;
00153         IMPORT_C const TPtrC UserName() const;
00160         IMPORT_C const TPtrC Password() const;
00167         IMPORT_C TInt32 ContextId() const;
00174         IMPORT_C TBool IsItem() const;
00181         IMPORT_C TBool IsFolder() const;
00188         IMPORT_C TBool IsFactoryItem() const;
00196         IMPORT_C TBool IsReadOnly() const;
00209         IMPORT_C TTime Modified() const;
00211     public:     // update
00218         IMPORT_C void ClearL();
00226         IMPORT_C void SetParentFolder( TInt aId );
00235         IMPORT_C void SetType( TType aType );
00244         IMPORT_C void SetNameL( const TDesC& aName );
00253         IMPORT_C void SetUrlL( const TDesC& aUrl );
00261         IMPORT_C void SetWapAp( const TFavouritesWapAp& aAccessPoint );
00270         IMPORT_C void SetUserNameL( const TDesC& aUserName );
00279         IMPORT_C void SetPasswordL( const TDesC& aPassword );
00287         IMPORT_C void SetContextId( TInt32 aContextId );
00294         IMPORT_C TBool IsHidden() const;        
00302         IMPORT_C TBool SetHidden(TBool aHidden) const;        
00304     public:     // (But not exported:) Streaming
00312         void ExternalizeL( RWriteStream& aStream ) const;
00320         void InternalizeL( RReadStream& aStream );
00322     private:    // Constructors
CFavouritesItem();
00334         void ConstructL();
00336     private:    // Data
00338         CFavouritesItemImpl* iImpl; 
00340     private:    // friends
00342         // Setting UID and accessing implementation is granted to this.
00343         friend class RFavouritesDb;
00345     };
00347 #endif
00348             
00349 // End of File