1 /*

     2 * Copyright (c) 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 class for storing objects embedded in CFsRichText

    15 *

    16 */

    17 

    18 

    19 #ifndef M_FSRICHTEXTOBJECT_H

    20 #define M_FSRICHTEXTOBJECT_H

    21 

    22 #include <e32base.h>

    23 class MFsRichTextObject

    24     {

    25     public:

    26         enum TFsRichTextObjectType

    27             {

    28                 EFsText = 1,

    29                 EFsTexture,

    30                 EFsHotspot,

    31                 EFsSmiley,

    32                 EFsNewLine

    33             };

    34         

    35     public:

    36         /**

    37         * GetType() const;

    38         * 

    39         * 

    40         */

    41         TFsRichTextObjectType GetType() const;

    42         

    43         /**

    44         * GetBeginOfObject() const;

    45         * 

    46         * 

    47         */

    48         TInt GetBeginOfObject() const;

    49         

    50         /**

    51         * GetEndOfObject() const;

    52         * 

    53         * 

    54         */

    55         TInt GetEndOfObject() const;

    56         

    57         /**

    58         * SetBeginOfObject(TInt aBeginOfObject);

    59         * 

    60         * @param aBeginOfObject

    61         */

    62         void SetBeginOfObject(TInt aBeginOfObject);

    63         

    64         /**

    65         * SetEndOfObject(TInt aEndOfObject);

    66         * 

    67         * @param aEndOfObject

    68         */

    69         void SetEndOfObject(TInt aEndOfObject);

    70         

    71         /**

    72         * SetEmbeded(TBool aEmbeded);

    73         * 

    74         * @param aEmbeded

    75         */

    76         void SetEmbeded(TBool aEmbeded);

    77         

    78         /**

    79         * SetIdOfEmbeded(TInt aIdOfEmbeded);

    80         * 

    81         * @param aIdOfEmbeded

    82         */

    83         void SetIdOfEmbeded(TInt aIdOfEmbeded);

    84         

    85         /**

    86         * GetEmbeded() const;

    87         * 

    88         * 

    89         */

    90         TBool GetEmbeded() const;

    91         

    92         /**

    93         * GetIdOfEmbeded() const;

    94         * 

    95         * 

    96         */

    97         TInt GetIdOfEmbeded() const;

    98         

    99         /**

   100         * SetHotSpot(TBool aHotSpot);

   101         * 

   102         * @param aHotSpot

   103         */

   104         void SetHotSpot(TBool aHotSpot);

   105         

   106         /**

   107         * SetIdOfHotSpot(TInt aIdOfHotSpot);

   108         * 

   109         * @param aIdOfHotSpot

   110         */

   111         void SetIdOfHotSpot(TInt aIdOfHotSpot);

   112         

   113         /**

   114         * SetTypeOfHotSpot(TInt aTypeOfHotSpot);

   115         * 

   116         * @param aTypeOfHotSpot

   117         */

   118         void SetTypeOfHotSpot(TInt aTypeOfHotSpot);

   119 

   120         /**

   121         * SetWhiteSpace(TBool aWhiteSpace);

   122         * 

   123         * @param aWhiteSpace

   124         */

   125         void SetIsWhiteSpace(TBool aIsWhiteSpace);        

   126 

   127         /**

   128         * GetHotSpot() const;

   129         * 

   130         * 

   131         */

   132         TBool GetHotSpot() const;

   133         

   134         /**

   135         * GetIdOfHotSpot()const;

   136         * 

   137         * 

   138         */

   139         TInt GetIdOfHotSpot()const;

   140         

   141         /**

   142         * GetTypeOfHotSpot()const;

   143         * 

   144         * 

   145         */

   146         TInt GetTypeOfHotSpot()const;

   147 

   148 	    /**

   149         *  GetIsWhiteSpace()const;

   150         * 

   151         * 

   152         */

   153 	    TBool GetIsWhiteSpace() const;       

   154 

   155         /**

   156         * ~MFsRichTextObject()

   157         * 

   158         * 

   159         */

   160         virtual ~MFsRichTextObject() {};

   161 

   162     protected:

   163         TFsRichTextObjectType iType;

   164         TInt iBeginOfObject;

   165         TInt iEndOfObject;

   166         TBool iEmbeded;

   167         TInt iIdOfEmbeded;

   168         

   169         TBool iHotSpot;

   170         TInt iIdOfHotSpot;

   171         TInt iTypeOfHotSpot;

   172 	    TBool iIsWhiteSpace;

   173     };

   174 

   175 #endif // M_FSRICHTEXTOBJECT_H

   176