williamr@2: /*
williamr@2: * Copyright (c) 2005 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@4: * under the terms of "Eclipse Public License v1.0"
williamr@2: * which accompanies this distribution, and is available
williamr@4: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description: Serene property interface declaration      
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: #ifndef M_SEN_PROPERTY_H
williamr@2: #define M_SEN_PROPERTY_H
williamr@2: 
williamr@2: // INCLUDES
williamr@2: #include <e32std.h>
williamr@2: 
williamr@2: class MSenProperty
williamr@2:     {
williamr@2:     public:
williamr@2:         /**
williamr@2:         * Gets the name of the property
williamr@2:         *
williamr@2:         * @return TPtrC8 containing name
williamr@2:         */
williamr@2:         virtual TPtrC8 Name() = 0;
williamr@2: 
williamr@2:         /**
williamr@2:         * Gets the type of the property
williamr@2:         *
williamr@2:         * @return TPtrC8 containing type
williamr@2:         */
williamr@2:         virtual TPtrC8 Type() = 0;
williamr@2: 
williamr@2:         /**
williamr@2:         * Gets the value of the property
williamr@2:         *
williamr@2:         * @return TPtrC8 containing value
williamr@2:         */
williamr@2:         virtual TPtrC8 Value() = 0;
williamr@2: 
williamr@2:         /**
williamr@2:         * Gets the integer value of the property
williamr@2:         *
williamr@2:         * @param aValue   A TInt reference to be filled in with the value of
williamr@2:         *                 the property.
williamr@2:         * @return         KErrNone if no error, or some of the system wide
williamr@2:         *                 error codes.
williamr@2:         */
williamr@2:         virtual TInt IntValue(TInt& aValue) = 0;
williamr@2: 
williamr@2:         /**
williamr@2:         * Gets the boolean value of the property
williamr@2:         *
williamr@2:         * @param aValue   A TBool reference to be filled in with the value of
williamr@2:         *                 the property.
williamr@2:         * @return         KErrNone if no error, or some of the system wide
williamr@2:         *                 error codes.
williamr@2:         */
williamr@2:         virtual TInt BoolValue(TBool& aValue) = 0;
williamr@2:         
williamr@2:         /**
williamr@2:         * Populates given array with the tokens delimited by given delimiter.
williamr@2:         * Note! Ownership of the TPtrC8 pointers is transfered to the caller.
williamr@2:         * @param aDelimiter Used delimiter.
williamr@2:         * @param aTokens    Array which will be populated by tokens.
williamr@2:         * @return           KErrNone if tokens were found.
williamr@2:         *                   KErrNotFound if tokens were not found.
williamr@2:         */
williamr@2:         virtual TInt ValueTokensL(const TDesC8& aDelimiter,
williamr@2:                                   RPointerArray<TPtrC8>& aTokens) = 0;
williamr@2:         
williamr@2:     };
williamr@2: 
williamr@2: #endif // M_SEN_PROPERTY_H
williamr@2: 
williamr@2: // End of File
williamr@2: