messagingappbase/smilengine/xhtml/inc/xhtmlhyperlink.h
changeset 0 72b543305e3a
equal deleted inserted replaced
-1:000000000000 0:72b543305e3a
       
     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:  xhtmlhyperlink  declaration
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef XHTMLHYPERLINK_H
       
    21 #define XHTMLHYPERLINK_H
       
    22 
       
    23 #include <e32base.h>
       
    24 
       
    25 /**
       
    26  *  CXhtmlHyperLink class encapsulates hypertext-related information 
       
    27  *
       
    28  *  @code
       
    29  *   ?good_class_usage_example(s)
       
    30  *  @endcode
       
    31  *
       
    32  *  @lib ?library
       
    33  *  @since S60 v3.2
       
    34  */
       
    35 NONSHARABLE_CLASS( CXhtmlHyperLink ) : public CBase
       
    36     {
       
    37 public:
       
    38 
       
    39     /**
       
    40     * Constructor.
       
    41     */
       
    42     CXhtmlHyperLink(TInt aStartPosition, TInt aEndPosition);
       
    43     
       
    44     /**
       
    45     * Destructor.
       
    46     */
       
    47     virtual ~CXhtmlHyperLink();
       
    48     
       
    49     /**
       
    50      * Sets target URL of the link.
       
    51      *
       
    52      * @since S60 v3.2
       
    53      * @param aAddress target URL of the link
       
    54      */      
       
    55     inline void SetAddressL(TPtrC &aAddress) { iAddress = aAddress.AllocL(); };
       
    56     
       
    57     /**
       
    58      * Returns start position of the link text.
       
    59      *
       
    60      * @since S60 v3.2
       
    61      * @return Start position of the link
       
    62      */
       
    63     inline TInt StartPosition() { return iStartPosition; };
       
    64     
       
    65     /**
       
    66      * Returns end position of the link text.
       
    67      *
       
    68      * @since S60 v3.2
       
    69      * @return End position of the link
       
    70      */
       
    71     inline TInt EndPosition() { return iEndPosition; };
       
    72     
       
    73     /**
       
    74      * Returns target URL of the link. 
       
    75      *
       
    76      * @since S60 v3.2
       
    77      * @return Target URL of the link
       
    78      */
       
    79     inline HBufC* Address() { return iAddress; };
       
    80     
       
    81 private: // data
       
    82 
       
    83     /**
       
    84      * Start position of the link text.
       
    85      */
       
    86 	TInt iStartPosition;
       
    87     
       
    88     /**
       
    89      * End position of the link text.
       
    90      */
       
    91     TInt iEndPosition;
       
    92     
       
    93     /**
       
    94     * Target URL of the link.
       
    95     */
       
    96     HBufC* iAddress;
       
    97     };
       
    98 	
       
    99 #endif