2 * Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
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".
9 * Initial Contributors:
10 * Nokia Corporation - initial contribution.
21 RParagraphStyleInfo::RParagraphStyleInfo()
22 : iStyle(NULL),iStyleForNextPara(NULL)
23 /** This default C++ constructor is used to construct the object, initializing
24 both style pointers to NULL. */
27 RParagraphStyleInfo::RParagraphStyleInfo(CParagraphStyle* aStyle,CParagraphStyle* aStyleForNextPara)
28 : iStyle(aStyle),iStyleForNextPara(aStyleForNextPara)
29 /** The C++ constructor is used to construct the object with a pointer to the style
30 information for the current paragraph and optionally a pointer to the style
31 information for the next paragraph.
33 @param aStyle The style to apply to the current paragraph.
34 @param aStyleForNextPara Optionally, the style to apply to the next paragraph.
40 void RParagraphStyleInfo::Discard()
41 /** Deletes the style pointer owned by the object. The pointer to the style for
42 the following paragraph is not deleted. */
48 CCharFormatLayer* CParagraphStyle::CharFormatLayer()const
49 /** Gets a pointer to the character format layer owned by the object.
53 The style's character formatting is set and retrieved using this pointer.
55 @return Pointer to the style's global character format layer. */
56 {return iCharFormatLayer;}
59 TInt CParagraphStyle::OutlineLevel()const
60 /** Gets the style's outline level.
62 @return The style's outline level. */
63 {return iOutlineLevel;}
68 void CParagraphStyle::SetOutlineLevel(TInt aOutlineLevel)
69 /** Sets the style's outline level.
71 @param aOutlineLevel The style's new outline level. */
72 {iOutlineLevel=aOutlineLevel;}
77 void CParagraphStyle::SetType(TUid aType)
78 /** Sets the style's type UID. On construction, the style's type UID is initialized
79 to KUserDefinedParagraphStyleUid to distinguish it from ordinary paragraph
80 format layers, which have a type of KNormalParagraphStyleUid. This function
81 can be used to change it to another value.
83 @param aType The style's type UID. */
88 CParagraphStyle* CParagraphStyle::CloneL()const
89 /** Creates and returns a CParagraphStyle object which is a clone of the current
92 @return Pointer to a clone of the current style. */
93 {return STATIC_CAST(CParagraphStyle*,DoCloneL());}
98 const RParagraphStyleInfo& CStyleList::operator[](TInt aIndex)const
99 /** Gets a style from the style list, from its index into the array. Two versions
100 are supplied. The compiler chooses the appropriate version based on the use
101 made of the returned reference. If it is used in an expression where the reference
102 can be modified, then the non-const version is chosen.
104 @param aIndex The index of the style into the list. The first style is at
105 position zero. Must be within the bounds of the array or a panic occurs.
106 @return A const reference to the style at position aIndex in the array.
107 @return A non-const reference to the style at position aIndex in the array. */
108 /** Gets a style from the style list, from its index into the array. Two versions
109 are supplied. The compiler chooses the appropriate version based on the use
110 made of the returned reference. If it is used in an expression where the reference
111 can be modified, then the non-const version is chosen.
113 @param aIndex The index of the style into the list. The first style is at
114 position zero. Must be within the bounds of the array or a panic occurs.
115 @return A const reference to the style at position aIndex in the array.
116 @return A non-const reference to the style at position aIndex in the array. */
117 {return iList->At(aIndex);}
120 RParagraphStyleInfo& CStyleList::operator[](TInt aIndex)
121 {return iList->At(aIndex);}
125 TInt CStyleList::Count()const
126 /** Gets the number of styles in the style list.
128 @return The number of styles in the style list */
129 {return (iList) ? iList->Count() : 0;}