pimappsupport/vcardandvcal/inc/VERSIT.INL
changeset 0 f979ecb2b13e
equal deleted inserted replaced
-1:000000000000 0:f979ecb2b13e
       
     1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 inline void CLineReader::SetPlugIn(MVersitPlugIn* aPlugIn)
       
    17 /** Sets the plug-in.
       
    18 
       
    19 Allows implemented functions of the MVersitPlugIn class to be used in specifying 
       
    20 options for adding and deleting spaces to/from the buffer. 
       
    21 
       
    22 Specifically, the plug-in is used to determine whether an additional space should 
       
    23 be added when appending a line to the buffer (by default a space will be added), 
       
    24 and whether the white space at the start of a line should form part of the data 
       
    25 (by default it will not form part of the data).
       
    26 
       
    27 Using a plug-in is optional. 
       
    28 
       
    29 @param aPlugIn A pointer to an MVersitPlugIn instance. */
       
    30 	{iPlugIn=aPlugIn;}
       
    31 
       
    32 inline void CLineReader::SetSkipWhiteSpaceAtStart(TBool aDoSkip)
       
    33 	{iSkipWhiteSpaceAtStart=aDoSkip;}
       
    34 
       
    35 inline void CVersitParser::SetObserver(MVersitObserver* aObserver)
       
    36 /** Sets the Versit observer.
       
    37 
       
    38 @param aObserver A pointer to the observer. */
       
    39 	{iObserver=aObserver;}
       
    40 
       
    41 inline MVersitObserver* CVersitParser::Observer()
       
    42 /** Gets a pointer to the Versit observer.
       
    43 
       
    44 @return A pointer to the observer. */
       
    45 	{return iObserver;}
       
    46 
       
    47 inline void CVersitParser::SetPlugIn(MVersitPlugIn* aPlugIn)
       
    48 /** Sets the Versit plug-in.
       
    49 
       
    50 If there is one, the Versit plug-in needs to be set before any properties are 
       
    51 added to the parser. This is done for you when internalising (using InternalizeL()) 
       
    52 or adding properties (using AddPropertyL()).
       
    53 
       
    54 @param aPlugIn A pointer to the plug in. */
       
    55 	{iPlugIn=aPlugIn;}
       
    56 
       
    57 inline MVersitPlugIn* CVersitParser::PlugIn()
       
    58 /** Gets a pointer to the Versit plug-in.
       
    59 
       
    60 @return A pointer to the plug-in. */
       
    61 	{return iPlugIn;}
       
    62 
       
    63 /* Gets a pointer to the read buffer owned by the CLineReader.
       
    64  *
       
    65  * @return Pointer to the read buffer. */
       
    66 inline TPtr8& CVersitParser::BufPtr()
       
    67 	{return iLineReader->iBufPtr;}
       
    68 
       
    69 /*
       
    70  * Check the iFlags to see if <code>ESupportsVersion</code> is set
       
    71  *
       
    72  * @return    " TBool "
       
    73  *            <code>ETrue</code> if the parser supports the version property
       
    74  *            <code>EFalse</code> otherwise
       
    75  */
       
    76 inline TBool CVersitParser::SupportsVersion() const
       
    77 	{return iFlags & ESupportsVersion;}
       
    78 
       
    79 /*
       
    80  * Sets the iFlags to <code>ESupportsVersion</code>
       
    81  */
       
    82 inline void CVersitParser::SetSupportsVersion()
       
    83 	{iFlags |= ESupportsVersion;}
       
    84 
       
    85 /*
       
    86  * Clear the bit of <code>ESupportsVersion</code> in iFlags'
       
    87  */
       
    88 inline void CVersitParser::ClearSupportsVersion()
       
    89 	{iFlags &= ~ESupportsVersion;}
       
    90 
       
    91 /*
       
    92  * Set Flags
       
    93  */
       
    94 inline void CVersitParser::SetFlags(TUint aFlags)
       
    95 	{iFlags |= aFlags;}
       
    96 
       
    97 /*
       
    98  * Gets a reference to <code>CVersitUnicodeUtils</code>
       
    99  * which is used for charset conversion 
       
   100  *
       
   101  * @return    " CVersitUnicodeUtils&"
       
   102  *            reference to <code>CVersitUnicodeUtils</code>
       
   103  */
       
   104 inline CVersitUnicodeUtils& CVersitParser::UnicodeUtils()
       
   105 	{ return iStaticUtils->UnicodeUtils(); }