1 /*

     2 * Copyright (c) 2006, 2007 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 "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Interface for enum presence info field value object.

    15 *

    16 */

    17 

    18 #ifndef MXIMPFWPRESENCEINFOFIELDVALUEENUM_H

    19 #define MXIMPFWPRESENCEINFOFIELDVALUEENUM_H

    20 

    21 #include <e32std.h>

    22 #include <ximpbase.h>

    23 #include <presencedatamodelifids.hrh>

    24 

    25 

    26 /**

    27  * Interface for presence information field value having

    28  * an enumerated integer value.

    29  *

    30  * @ingroup presencedatamodelapi

    31  * @since S60 v3.2

    32  */

    33 class MPresenceInfoFieldValueEnum : public MXIMPBase

    34     {

    35 public:

    36 

    37     /** Interface ID for the MPresenceInfoFieldValueEnum. */

    38     enum { KInterfaceId = PRES_IF_ID_PRESENCE_INFO_FIELD_VALUE_ENUM };

    39 

    40 public:

    41 

    42     /**

    43      * Public destructor. MPresenceInfoFieldValueEnum object

    44      * can be deleted through this interface.

    45      */

    46     virtual ~MPresenceInfoFieldValueEnum() {}

    47 

    48 

    49 public:

    50 

    51     /**

    52      * Returns minimum value of enumeration.

    53      *

    54      * @return Minimum allowed value for enumeration

    55      */

    56     virtual TInt MinValue() const = 0;

    57 

    58 

    59     /**

    60      * Returns maximum value of enumeration.

    61      *

    62      * @return Maximum allowed value for enumeration

    63      */

    64     virtual TInt MaxValue() const = 0;

    65 

    66 

    67     /**

    68      * Returns Value of enumeration.

    69      *

    70      * @return Value of enumeration

    71      */

    72     virtual TInt Value() const = 0;

    73 

    74 

    75     /**

    76      * Set the value of the enumeration.

    77      *

    78      * @param [in] aValue

    79      *             New enum value to set

    80      *

    81      * @leave KErrUnderFlow If the enum value is less than the allowed minimum

    82      * @leave KErrOverFlow If the enum value is more than the allowed maximum

    83      */

    84     virtual void SetValueL( TInt aValue ) = 0;

    85 

    86     /**

    87      * Set the minimum and maximum allowed by the enumeration.

    88      * The value range set is inclusive, that is [aMin..aMax].

    89      * @param aMin The minimum

    90      * @param aMax The maximum

    91      */

    92     virtual void SetLimits( TInt aMin, TInt aMax ) = 0;

    93 

    94     };

    95 

    96 #endif //MXIMPFWPRESENCEINFOFIELDVALUEENUM_H

    97 

    98 

    99