omacpadapters/WAPAdapter/Inc/CWPWAPBookmarkItem.h
author hgs
Fri, 15 Oct 2010 11:39:02 +0530
changeset 67 fdbfe0a95492
parent 47 d316aecb87fd
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
47
d316aecb87fd 201025_02
hgs
parents:
diff changeset
     1
/*
d316aecb87fd 201025_02
hgs
parents:
diff changeset
     2
* Copyright (c) 2002-2006 Nokia Corporation and/or its subsidiary(-ies). 
d316aecb87fd 201025_02
hgs
parents:
diff changeset
     3
* All rights reserved.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
d316aecb87fd 201025_02
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
d316aecb87fd 201025_02
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
d316aecb87fd 201025_02
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
d316aecb87fd 201025_02
hgs
parents:
diff changeset
     8
*
d316aecb87fd 201025_02
hgs
parents:
diff changeset
     9
* Initial Contributors:
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    11
*
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    12
* Contributors:
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    13
*
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    14
* Description:  One bookmark item in browser settings.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    15
*
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    16
*/
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    17
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    18
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    19
#ifndef CWPWAPBOOKMARKITEM_H
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    20
#define CWPWAPBOOKMARKITEM_H
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    21
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    22
// INCLUDES
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    23
#include <e32base.h>
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    24
#include <MWPVisitor.h>
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    25
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    26
#include "CWPWAPItemBAse.h"
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    27
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    28
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    29
// FORWARD DECLARATIONS
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    30
class CBookmarkDb;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    31
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    32
// CLASS DECLARATION
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    33
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    34
/**
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    35
 * CWPWAPBookmarkItem handles one bookmark item in browser settings.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    36
 *
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    37
 * @lib WPWAPAdapter
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    38
 * @since 2.0
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    39
 */ 
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    40
class CWPWAPBookmarkItem : public CBase, public MWPWAPItemBase, private MWPVisitor
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    41
    {
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    42
    public:  // Constructors and destructor
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    43
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    44
        /**
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    45
        * Two-phased constructor.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    46
        * @param aTitle The title to be returned in Name().
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    47
        * @param aDefaultName The default name for bookmarks.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    48
        * @param aCharacteristic The RESOURCE characteristic.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    49
        * @param aLink Link to NAPDEF
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    50
        * @param aDb The bookmark database to use. Created if NULL.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    51
        * @return CWPWAPBookmarkItem instance
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    52
        */
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    53
        static CWPWAPBookmarkItem* NewL(  const TDesC& aTitle, 
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    54
            const TDesC& aDefaultName, 
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    55
            CWPCharacteristic& aCharacteristic, 
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    56
            CWPCharacteristic*& aLink
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    57
            );
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    58
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    59
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    60
        /**
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    61
        * Destructor.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    62
        */
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    63
        ~CWPWAPBookmarkItem();
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    64
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    65
    public:   // From MWPMMSItemBase
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    66
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    67
        const TDesC& Name() const;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    68
        const TDesC& Title() const;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    69
        TBool CanSetAsDefault() const;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    70
        void SaveL();
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    71
        void SetAsDefaultL();
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    72
        TBool ValidateL();
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    73
        void AddL( RPointerArray<MWPWAPItemBase>& aShownItems, 
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    74
            RPointerArray<MWPWAPItemBase>& aHiddenItems );
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    75
        const TDesC8& SaveData() const;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    76
        const TDesC& Address() const;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    77
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    78
    public:  // From MWPVisitor
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    79
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    80
        void VisitL(CWPCharacteristic& aCharacteristic);
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    81
        void VisitL(CWPParameter& aParameter);
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    82
        void VisitLinkL(CWPCharacteristic& aCharacteristic );
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    83
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    84
    private:  // New functions
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    85
        /**
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    86
        * C++ constructor.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    87
        * @param aTitle The title to be returned in Name().
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    88
        * @param aDefaultName The default name for bookmarks.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    89
        * @param aLink Link to access point
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    90
        * @param aDb The bookmark database to use. Created if NULL.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    91
        */
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    92
        CWPWAPBookmarkItem( const TDesC& aTitle, 
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    93
            const TDesC& aDefaultName, 
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    94
            CWPCharacteristic*& aLink
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    95
             );
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    96
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    97
        /**
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    98
        * By default Symbian 2nd phase constructor is private.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    99
        * @param aCharacteristic The RESOURCE characteristic 
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   100
        * to scan.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   101
        */
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   102
        void ConstructL( CWPCharacteristic& aCharacteristic );
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   103
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   104
        /**
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   105
        * Create the bookmarks db.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   106
        */
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   107
        void CreateDbL();
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   108
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   109
    private:
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   110
        // The title for bookmark items
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   111
        const TDesC& iTitle;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   112
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   113
        // The default name for bookmarks.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   114
        const TDesC& iDefaultName;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   115
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   116
        // The access point characteristic. Refs.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   117
        CWPCharacteristic*& iLink;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   118
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   119
        // The name of the bookmark
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   120
        TPtrC iName;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   121
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   122
        // The URI of the bookmark
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   123
        TPtrC iURI;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   124
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   125
        // Startpage parameter
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   126
        TBool iHasStartPage;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   127
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   128
        //RFavouritesDb       iBookmarkDb;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   129
        //RFavouritesSession  iSession;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   130
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   131
        // Access point uid.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   132
        TUint32 iUID;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   133
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   134
        // UIDs of the saved items
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   135
        TPckgBuf<TWPWAPSaveItem> iSaveItem;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   136
    };
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   137
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   138
#endif  // CWPWAPBOOKMARKITEM_H
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   139
            
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   140
// End of File