epoc32/include/mw/msenproperty.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     1 /*
     2 * Copyright (c) 2005 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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description: Serene property interface declaration      
    15 *
    16 */
    17 
    18 #ifndef M_SEN_PROPERTY_H
    19 #define M_SEN_PROPERTY_H
    20 
    21 // INCLUDES
    22 #include <e32std.h>
    23 
    24 class MSenProperty
    25     {
    26     public:
    27         /**
    28         * Gets the name of the property
    29         *
    30         * @return TPtrC8 containing name
    31         */
    32         virtual TPtrC8 Name() = 0;
    33 
    34         /**
    35         * Gets the type of the property
    36         *
    37         * @return TPtrC8 containing type
    38         */
    39         virtual TPtrC8 Type() = 0;
    40 
    41         /**
    42         * Gets the value of the property
    43         *
    44         * @return TPtrC8 containing value
    45         */
    46         virtual TPtrC8 Value() = 0;
    47 
    48         /**
    49         * Gets the integer value of the property
    50         *
    51         * @param aValue   A TInt reference to be filled in with the value of
    52         *                 the property.
    53         * @return         KErrNone if no error, or some of the system wide
    54         *                 error codes.
    55         */
    56         virtual TInt IntValue(TInt& aValue) = 0;
    57 
    58         /**
    59         * Gets the boolean value of the property
    60         *
    61         * @param aValue   A TBool reference to be filled in with the value of
    62         *                 the property.
    63         * @return         KErrNone if no error, or some of the system wide
    64         *                 error codes.
    65         */
    66         virtual TInt BoolValue(TBool& aValue) = 0;
    67         
    68         /**
    69         * Populates given array with the tokens delimited by given delimiter.
    70         * Note! Ownership of the TPtrC8 pointers is transfered to the caller.
    71         * @param aDelimiter Used delimiter.
    72         * @param aTokens    Array which will be populated by tokens.
    73         * @return           KErrNone if tokens were found.
    74         *                   KErrNotFound if tokens were not found.
    75         */
    76         virtual TInt ValueTokensL(const TDesC8& aDelimiter,
    77                                   RPointerArray<TPtrC8>& aTokens) = 0;
    78         
    79     };
    80 
    81 #endif // M_SEN_PROPERTY_H
    82 
    83 // End of File
    84