1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/textandloc/textrendering/texthandling/stext/MParser.cpp Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,138 @@
1.4 +/*
1.5 +* Copyright (c) 1999-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 +#include <mparser.h>
1.23 +
1.24 +
1.25 +// Given the text object, scan the specified range of the text buffer
1.26 +// (from aStartScan to one before aEndScan) and show the first match, if
1.27 +// any, that you would like tagged by setting the range (from aStartTag
1.28 +// to one before aEndTag). Return ETrue if you find anything, EFalse
1.29 +// otherwise. This function must be defined. If aAllowBack is ETrue then
1.30 +// the parser is allowed to recognise tags that start before but
1.31 +// continue into the range specified, otherwise it is not allowed to do
1.32 +// so (and, if it does, will assert in debug mode).
1.33 +// virtual TBool ParseThisText(const CRichText& aTextObj,
1.34 +// TBool aAllowBack,
1.35 +// TInt aStartScan,
1.36 +// TInt aScanLength,
1.37 +// TInt& aStartTag,
1.38 +// TInt& aTagLength) = 0;
1.39 +
1.40 +
1.41 +// The text cursor is over the text string in aTextObj (aLength
1.42 +// characters starting at aStartText). Return a const ptr to the string
1.43 +// that should be displayed for a "Do It!" button. (This can be
1.44 +// constant, such as a _LIT, or change according to the tagged text.)
1.45 +// The parser retains ownership of this string and, if necessary, should
1.46 +// delete it when this function is next called or when the parser is
1.47 +// deleted. This function will normally be invoked directly by UIKON and
1.48 +// must be defined.
1.49 +// virtual const TDesC& CreateDoItText(const CRichText& aTextObj,
1.50 +// TInt aStartText,
1.51 +// TInt aLength) = 0;
1.52 +
1.53 +
1.54 +// The text cursor is over the text string in aTextObj (aLength
1.55 +// characters starting at aStartText) and the "Do It!" button has been
1.56 +// pushed (or some other activation method has been triggered). Do
1.57 +// whatever should happen (such as launching a browser with the
1.58 +// indicated URL). If the parser requires a copy of the text to pass on,
1.59 +// it is up to it to take one before doing anything (such as handing it
1.60 +// to a separate thread) and to dispose of it later. This function will
1.61 +// normally be invoked directly by UIKON and must be defined.
1.62 +// virtual void ActivateThisTextL(const CRichText& aTextObj,
1.63 +// TInt aStartText,
1.64 +// TInt aLength) = 0;
1.65 +
1.66 +
1.67 +// Whether this parser makes any formatting changes to text that is
1.68 +// recognised and tagged as soon as it has been recognised. If it does
1.69 +// then this function should be overridden with one that returns ETrue
1.70 +// and the GetRecogniseFormat() function should be overridden
1.71 +// appropriately - otherwise do nothing.
1.72 +EXPORT_C TBool MParser::ReformatOnRecognise() const
1.73 + {
1.74 + return EFalse;
1.75 + }
1.76 +
1.77 +
1.78 +// Whether this parser makes any formatting changes to text that is
1.79 +// recognised and tagged when the text cursor moves onto it. If it does
1.80 +// then this function should be overridden with one that returns ETrue
1.81 +// and the GetRolloverFormat() function should be overridden
1.82 +// appropriately otherwise do nothing.
1.83 +EXPORT_C TBool MParser::ReformatOnRollover() const
1.84 + {
1.85 + return EFalse;
1.86 + }
1.87 +
1.88 +
1.89 +// Given an existing format, modify it to reflect the highlighting
1.90 +// changes that apply immediately some text is recognised and tagged by
1.91 +// this parser. If this parser does not make any highlighting changes at
1.92 +// recognise time then this function should not be overridden.
1.93 +EXPORT_C void MParser::GetRecogniseFormat(TCharFormat& /*aFormat*/)
1.94 + {
1.95 + }
1.96 +
1.97 +
1.98 +// Given an existing format, modify it to reflect the highlighting
1.99 +// changes that apply when the text cursor moves onto text that has been
1.100 +// recognised and tagged by this parser. This should include all changes
1.101 +// that you wish to make to the base format as this will *not* be
1.102 +// applied cumulatively to the recognise highlighting. If this parser
1.103 +// does not make any highlighting changes at rollover time then this
1.104 +// function should not be overridden and any recognise highlighting will
1.105 +// remain.
1.106 +EXPORT_C void MParser::GetRolloverFormat(TCharFormat& aFormat)
1.107 + {
1.108 + GetRecogniseFormat(aFormat);
1.109 + }
1.110 +
1.111 +
1.112 +EXPORT_C TBool MParser::ConfirmCursorOverTag(const CRichText& /*aTextObj*/,
1.113 + TInt /*aTagStart*/, TInt /*aTagLen*/, TInt /*aCurPos*/)
1.114 +/**
1.115 + This confirmation routine is called by the parsing framework when
1.116 + it's logic determines the cursor is over a tag. It gives the parser
1.117 + a chance to override the default cursor-tag rollover matching. This
1.118 + is not necessary if the default behaviour is acceptable.
1.119 + It is called from the CRichText::CursorOverTag()
1.120 + when the framework tests for format redraw when over a tag and
1.121 + CRichText::OverrideFormatForParsersIfApplicable() when Tagma
1.122 + is formatting text.
1.123 +@publishedPartner
1.124 +@released
1.125 +@param aTextObj
1.126 + A reference to the text document tag is within.
1.127 +@param aTagStart
1.128 + The document position of the first tag character.
1.129 +@param aTagLen
1.130 + The number of characters in the tag.
1.131 +@param aCurPos
1.132 + The cursor position used in calculation of calling routines.
1.133 +@return TBool
1.134 + ETrue if parser agrees cursor over a tag, EFalse otherwise.
1.135 +*/
1.136 + {
1.137 + return ETrue;
1.138 + }
1.139 +
1.140 +
1.141 +EXPORT_C void MParser::MParser_Reserved_2() {}