omacpadapters/WAPAdapter/Inc/MWPWAPItemBase.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 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: 
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    15
*     Base class for WAP setting items.
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
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    20
#ifndef MWPWAPITEMBASE_H
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    21
#define MWPWAPITEMBASE_H
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    22
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    23
// INCLUDES
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    24
#include <e32base.h>
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    25
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    26
// CONSTANTS
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    27
const TUint32 KWPWAPNoUID = 0;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    28
const TUint32 KWPWAPItemTypeNone = 0;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    29
const TUint32 KWPWAPItemTypeBookmark = 1;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    30
const TUint32 KWPWAPItemTypeAccesspoint = 2;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    31
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    32
// FORWARD DECLARATIONS
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    33
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    34
// CLASS DECLARATION
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    35
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    36
/**
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    37
 * MWPWAPItemBase is a base class for wap settings.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    38
 *
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    39
 * @lib WPWAPAdapter
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    40
 * @since 2.0
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    41
 */ 
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    42
class MWPWAPItemBase
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    43
    {
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    44
	public:
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    45
		struct TWPWAPSaveItem
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    46
			{
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    47
			TUint32 iSaveItemType;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    48
			TUint32 iUID;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    49
			};
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    50
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    51
    public:  // Constructors and destructor
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    52
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    53
        /**
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    54
        * Destructor.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    55
        */
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    56
        virtual ~MWPWAPItemBase() {};
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    57
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    58
    public:   // New functions
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    59
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    60
        /**
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    61
        * Returns the name of the item to be returned in
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    62
        * SummaryText().
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    63
        * @return Name of the item
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    64
        */
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    65
        virtual const TDesC& Name() const = 0;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    66
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    67
        /**
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    68
        * Returns the title of the item to be returned in
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    69
        * SummaryTitle().
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    70
        * @return Name of the item
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    71
        */
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    72
        virtual const TDesC& Title() const = 0;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    73
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    74
        /**
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    75
        * Returns the address of the service pointed by 
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    76
        * the item.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    77
        * @return Address of the service
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    78
        */
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    79
        virtual const TDesC& Address() const = 0;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    80
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    81
        /**
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    82
        * Saves the item. Call BaseSaveL() in beginning.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    83
        */
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    84
        virtual void SaveL() = 0;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    85
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    86
        /**
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    87
        * Returns ETrue if the item can be saved as
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    88
        * default setting.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    89
        * @return Whether the item can be made default
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    90
        */
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    91
        virtual TBool CanSetAsDefault() const = 0;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    92
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    93
        /**
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    94
        * Sets the item as default setting.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    95
        */
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    96
        virtual void SetAsDefaultL() = 0;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    97
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    98
        /**
d316aecb87fd 201025_02
hgs
parents:
diff changeset
    99
        * Returns ETrue if the item is valid.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   100
        * @return ETrue if valid
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   101
        */
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   102
        virtual TBool ValidateL() = 0;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   103
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   104
        /**
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   105
        * Adds the item and its children to a list of items.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   106
        * @param aShownItems The list of shown items to be appended to
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   107
        * @param aHiddenItems The list of hidden items to be appended to
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   108
        */
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   109
        virtual void AddL( RPointerArray<MWPWAPItemBase>& aShownItems, 
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   110
            RPointerArray<MWPWAPItemBase>& aHiddenItems  ) = 0;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   111
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   112
        /**
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   113
        * Returns the ID of the saved item.
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   114
        * @return ID of the saved item, or KWPWAPNoUID
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   115
        */
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   116
        virtual const TDesC8& SaveData() const = 0;
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   117
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   118
    };
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   119
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   120
#endif  // MWPWAPITEMBASE_H
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   121
            
d316aecb87fd 201025_02
hgs
parents:
diff changeset
   122
// End of File