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