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

    15 *

    16 */

    17 

    18 #ifndef MXIMPFWPRESENCEINFOFIELDVALUETEXT_H

    19 #define MXIMPFWPRESENCEINFOFIELDVALUETEXT_H

    20 

    21 #include <e32std.h>

    22 #include <ximpbase.h>

    23 #include <presencedatamodelifids.hrh>

    24 

    25 

    26 

    27 /**

    28  * Interface for textual presence info field value object..

    29  *

    30  * Interface for presence information field value having

    31  * textual format. Contained text can be rendered to

    32  * end user as is.

    33  *

    34  * @ingroup presencedatamodelapi

    35  * @since S60 v3.2

    36  */

    37 class MPresenceInfoFieldValueText : public MXIMPBase

    38     {

    39 public:

    40 

    41     /** Interface ID for the MPresenceInfoFieldValueText. */

    42     enum { KInterfaceId = PRES_IF_ID_PRESENCE_INFO_FIELD_VALUE_TEXT };

    43 

    44 

    45 public:

    46 

    47     /**

    48      * Public destructor. MPresenceInfoFieldValueText object

    49      * can be deleted through this interface.

    50      */

    51     virtual ~MPresenceInfoFieldValueText() {}

    52 

    53 

    54 public:

    55 

    56     /**

    57      * Returns maximum length of the field value.

    58      *

    59      * @return Maximum length of the field value or

    60      *         KXIMPFieldValueLengthUnlimited if the value

    61      *         length is limited only by the available resources.

    62      */

    63     virtual TInt MaxLength() const = 0;

    64 

    65 

    66     /**

    67      * Returns the textual value.

    68      *

    69      * @return The textual value.

    70      */

    71     virtual TPtrC TextValue() const =0;

    72 

    73 

    74     /**

    75      * Sets the textual data.

    76      *

    77      * @param [in] aValue

    78      *        New textual value to set.

    79      *

    80      * @leave KErrOverflow if value length exceeds field specific maxlength.

    81      * @leave KErrNoMemory if failed to allocate memory.

    82      */

    83     virtual void SetTextValueL(

    84                 const TDesC& aValue ) =0;

    85 

    86     };

    87 

    88 

    89 #endif //MXIMPFWPRESENCEINFOFIELDVALUETEXT_H

    90 

    91 

    92