1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/app/versit.inl Wed Mar 31 12:27:01 2010 +0100
1.3 @@ -0,0 +1,112 @@
1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// CVersitParser
1.18 +//
1.19 +//
1.20 +
1.21 +inline void CLineReader::SetPlugIn(MVersitPlugIn* aPlugIn)
1.22 +/** Sets the plug-in.
1.23 +
1.24 +Allows implemented functions of the MVersitPlugIn class to be used in specifying
1.25 +options for adding and deleting spaces to/from the buffer.
1.26 +
1.27 +Specifically, the plug-in is used to determine whether an additional space should
1.28 +be added when appending a line to the buffer (by default a space will be added),
1.29 +and whether the white space at the start of a line should form part of the data
1.30 +(by default it will not form part of the data).
1.31 +
1.32 +Using a plug-in is optional.
1.33 +
1.34 +@param aPlugIn A pointer to an MVersitPlugIn instance. */
1.35 + {iPlugIn=aPlugIn;}
1.36 +
1.37 +inline void CLineReader::SetSkipWhiteSpaceAtStart(TBool aDoSkip)
1.38 + {iSkipWhiteSpaceAtStart=aDoSkip;}
1.39 +
1.40 +
1.41 +//
1.42 +// CVersitParser
1.43 +//
1.44 +
1.45 +inline void CVersitParser::SetObserver(MVersitObserver* aObserver)
1.46 +/** Sets the Versit observer.
1.47 +
1.48 +@param aObserver A pointer to the observer. */
1.49 + {iObserver=aObserver;}
1.50 +
1.51 +inline MVersitObserver* CVersitParser::Observer()
1.52 +/** Gets a pointer to the Versit observer.
1.53 +
1.54 +@return A pointer to the observer. */
1.55 + {return iObserver;}
1.56 +
1.57 +inline void CVersitParser::SetPlugIn(MVersitPlugIn* aPlugIn)
1.58 +/** Sets the Versit plug-in.
1.59 +
1.60 +If there is one, the Versit plug-in needs to be set before any properties are
1.61 +added to the parser. This is done for you when internalising (using InternalizeL())
1.62 +or adding properties (using AddPropertyL()).
1.63 +
1.64 +@param aPlugIn A pointer to the plug in. */
1.65 + {iPlugIn=aPlugIn;}
1.66 +
1.67 +inline MVersitPlugIn* CVersitParser::PlugIn()
1.68 +/** Gets a pointer to the Versit plug-in.
1.69 +
1.70 +@return A pointer to the plug-in. */
1.71 + {return iPlugIn;}
1.72 +
1.73 +/* Gets a pointer to the read buffer owned by the CLineReader.
1.74 + *
1.75 + * @return Pointer to the read buffer. */
1.76 +inline TPtr8& CVersitParser::BufPtr()
1.77 + {return iLineReader->iBufPtr;}
1.78 +
1.79 +/*
1.80 + * Check the iFlags to see if <code>ESupportsVersion</code> is set
1.81 + *
1.82 + * @return " TBool "
1.83 + * <code>ETrue</code> if the parser supports the version property
1.84 + * <code>EFalse</code> otherwise
1.85 + */
1.86 +inline TBool CVersitParser::SupportsVersion() const
1.87 + {return iFlags & ESupportsVersion;}
1.88 +
1.89 +/*
1.90 + * Sets the iFlags to <code>ESupportsVersion</code>
1.91 + */
1.92 +inline void CVersitParser::SetSupportsVersion()
1.93 + {iFlags |= ESupportsVersion;}
1.94 +
1.95 +/*
1.96 + * Clear the bit of <code>ESupportsVersion</code> in iFlags'
1.97 + */
1.98 +inline void CVersitParser::ClearSupportsVersion()
1.99 + {iFlags &= ~ESupportsVersion;}
1.100 +
1.101 +/*
1.102 + * Set Flags
1.103 + */
1.104 +inline void CVersitParser::SetFlags(TUint aFlags)
1.105 + {iFlags |= aFlags;}
1.106 +
1.107 +/*
1.108 + * Gets a reference to <code>CVersitUnicodeUtils</code>
1.109 + * which is used for charset conversion
1.110 + *
1.111 + * @return " CVersitUnicodeUtils&"
1.112 + * reference to <code>CVersitUnicodeUtils</code>
1.113 + */
1.114 +inline CVersitUnicodeUtils& CVersitParser::UnicodeUtils()
1.115 + { return iStaticUtils->UnicodeUtils(); }