1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/textandloc/textrendering/texthandling/inc/TXTSTYLE.INL	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,129 @@
     1.4 +/*
     1.5 +* Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description: 
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 + 
    1.23 +
    1.24 +RParagraphStyleInfo::RParagraphStyleInfo()
    1.25 +	: iStyle(NULL),iStyleForNextPara(NULL)
    1.26 +/** This default C++ constructor is used to construct the object, initializing 
    1.27 +both style pointers to NULL. */
    1.28 +	{}
    1.29 +
    1.30 +RParagraphStyleInfo::RParagraphStyleInfo(CParagraphStyle* aStyle,CParagraphStyle* aStyleForNextPara)
    1.31 +	: iStyle(aStyle),iStyleForNextPara(aStyleForNextPara)
    1.32 +/** The C++ constructor is used to construct the object with a pointer to the style 
    1.33 +information for the current paragraph and optionally a pointer to the style 
    1.34 +information for the next paragraph.
    1.35 +
    1.36 +@param aStyle The style to apply to the current paragraph. 
    1.37 +@param aStyleForNextPara Optionally, the style to apply to the next paragraph. 
    1.38 +By default, NULL. */
    1.39 +	{}
    1.40 +
    1.41 + 
    1.42 +
    1.43 +void RParagraphStyleInfo::Discard()
    1.44 +/** Deletes the style pointer owned by the object. The pointer to the style for 
    1.45 +the following paragraph is not deleted. */
    1.46 +	{delete iStyle;}
    1.47 +
    1.48 +
    1.49 + 
    1.50 +
    1.51 +CCharFormatLayer* CParagraphStyle::CharFormatLayer()const
    1.52 +/** Gets a pointer to the character format layer owned by the object.
    1.53 +
    1.54 +Note
    1.55 +
    1.56 +The style's character formatting is set and retrieved using this pointer.
    1.57 +
    1.58 +@return Pointer to the style's global character format layer. */
    1.59 +	{return iCharFormatLayer;}
    1.60 +
    1.61 + 
    1.62 +TInt CParagraphStyle::OutlineLevel()const
    1.63 +/** Gets the style's outline level.
    1.64 +
    1.65 +@return The style's outline level. */
    1.66 +	{return iOutlineLevel;}
    1.67 +
    1.68 +
    1.69 + 
    1.70 +
    1.71 +void CParagraphStyle::SetOutlineLevel(TInt aOutlineLevel)
    1.72 +/** Sets the style's outline level.
    1.73 +
    1.74 +@param aOutlineLevel The style's new outline level. */
    1.75 +	{iOutlineLevel=aOutlineLevel;}
    1.76 +
    1.77 +
    1.78 + 
    1.79 +
    1.80 +void CParagraphStyle::SetType(TUid aType)
    1.81 +/** Sets the style's type UID. On construction, the style's type UID is initialized 
    1.82 +to KUserDefinedParagraphStyleUid to distinguish it from ordinary paragraph 
    1.83 +format layers, which have a type of KNormalParagraphStyleUid. This function 
    1.84 +can be used to change it to another value.
    1.85 +
    1.86 +@param aType The style's type UID. */
    1.87 +	{iType=aType;}
    1.88 +
    1.89 +
    1.90 + 
    1.91 +CParagraphStyle* CParagraphStyle::CloneL()const
    1.92 +/** Creates and returns a CParagraphStyle object which is a clone of the current 
    1.93 +style.
    1.94 +
    1.95 +@return Pointer to a clone of the current style. */
    1.96 +	{return STATIC_CAST(CParagraphStyle*,DoCloneL());}
    1.97 +
    1.98 +
    1.99 + 
   1.100 +
   1.101 +const RParagraphStyleInfo& CStyleList::operator[](TInt aIndex)const
   1.102 +/** Gets a style from the style list, from its index into the array. Two versions 
   1.103 +are supplied. The compiler chooses the appropriate version based on the use 
   1.104 +made of the returned reference. If it is used in an expression where the reference 
   1.105 +can be modified, then the non-const version is chosen.
   1.106 +
   1.107 +@param aIndex The index of the style into the list. The first style is at 
   1.108 +position zero. Must be within the bounds of the array or a panic occurs. 
   1.109 +@return A const reference to the style at position aIndex in the array. 
   1.110 +@return A non-const reference to the style at position aIndex in the array. */
   1.111 +/** Gets a style from the style list, from its index into the array. Two versions 
   1.112 +are supplied. The compiler chooses the appropriate version based on the use 
   1.113 +made of the returned reference. If it is used in an expression where the reference 
   1.114 +can be modified, then the non-const version is chosen.
   1.115 +
   1.116 +@param aIndex The index of the style into the list. The first style is at 
   1.117 +position zero. Must be within the bounds of the array or a panic occurs. 
   1.118 +@return A const reference to the style at position aIndex in the array. 
   1.119 +@return A non-const reference to the style at position aIndex in the array. */
   1.120 +	{return iList->At(aIndex);}
   1.121 +
   1.122 +
   1.123 +RParagraphStyleInfo& CStyleList::operator[](TInt aIndex)
   1.124 +	{return iList->At(aIndex);}
   1.125 +
   1.126 + 
   1.127 +
   1.128 +TInt CStyleList::Count()const
   1.129 +/** Gets the number of styles in the style list.
   1.130 +
   1.131 +@return The number of styles in the style list */
   1.132 +	{return (iList) ? iList->Count() : 0;}