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 presence info field object.

    15 *

    16 */

    17 

    18 #ifndef MXIMPFWPRESENCEINFOFIELD_H

    19 #define MXIMPFWPRESENCEINFOFIELD_H

    20 

    21 #include <e32std.h>

    22 #include <ximpbase.h>

    23 #include <presencedatamodelifids.hrh>

    24 

    25 

    26 /**

    27  * Interface for presence info field object.

    28  *

    29  *

    30  * @todo Interface might be extended with new methods.

    31  *

    32  * @ingroup presencedatamodelapi

    33  * @since S60 v3.2

    34  */

    35 class MPresenceInfoField : public MXIMPBase

    36     {

    37 public:

    38 

    39     /** Interface ID for the MPresenceInfoField. */

    40     enum { KInterfaceId = PRES_IF_ID_PRESENCE_FIELD };

    41 

    42 

    43 public:

    44 

    45     /**

    46      * Public destructor. MPresenceInfoField object

    47      * can be deleted through this interface.

    48      */

    49     virtual ~MPresenceInfoField() {}

    50 

    51 

    52 public:

    53 

    54 

    55     /**

    56      * Returns this presence information field's name.

    57      *

    58      * @return Presence information field's name.

    59      */

    60     virtual const TDesC8& FieldType() const =0;

    61     

    62     /**

    63      * Set this presence information field's name.

    64      * @param aFieldType The new field type

    65      */

    66     virtual void SetFieldTypeL( const TDesC8& aFieldType ) =0;

    67 

    68     /**

    69      * Returns read-only reference to this presence

    70      * information field's value storage.

    71      *

    72      * @return Presence information field's value storage.

    73      */

    74     virtual const MXIMPBase& FieldValue() const =0;

    75 

    76 

    77     /**

    78      * Returns modifiable reference to this presence

    79      * information field's value storage.

    80      *

    81      * @return Presence information field's value storage.

    82      */

    83     virtual MXIMPBase& FieldValue() =0;

    84     

    85     /**

    86      * Set the field value object for this field's value storage.

    87      * Ownership transferred.

    88      * @param aFieldValue The field value object

    89      */

    90     virtual void SetFieldValue( MXIMPBase* aFieldValue ) = 0;

    91 

    92     };

    93 

    94 

    95 

    96 #endif //MXIMPFWPRESENCEINFOFIELD_H

    97 

    98 

    99