epoc32/include/mparser.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h) This is the epoc32/include tree with the "platform" subtrees removed, and all but a selected few mbg and rsg files removed.

/*
* Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description: 
*
*/


#ifndef __MPARSER_H__
#define __MPARSER_H__

#include <e32base.h>
#include <e32std.h>

class CRichText;
class TCharFormat;

/**
 * Implement ParseThisText() in order to parse text
 * @publishedAll
 * @released
 */
class MParser
	{
public:
	virtual TBool ParseThisText(const CRichText& aTextObj,
								TBool aAllowBack,
								TInt aStartScan,
								TInt aScanLength,
								TInt& aStartTag,
								TInt& aTagLength) = 0;

	virtual const TDesC& CreateDoItText(const CRichText& aTextObj,
										TInt aStartText,
										TInt aLength) = 0;

	virtual void ActivateThisTextL(const CRichText& aTextObj,
								   TInt aStartText,
								   TInt aLength) = 0;

	IMPORT_C virtual TBool ReformatOnRecognise() const;

	IMPORT_C virtual TBool ReformatOnRollover() const;

	IMPORT_C virtual void GetRecogniseFormat(TCharFormat& aFormat);

	IMPORT_C virtual void GetRolloverFormat(TCharFormat& aFormat);

	IMPORT_C virtual TBool ConfirmCursorOverTag(const CRichText& aTextObj,
												TInt aTagStart,
												TInt aTagLen,
												TInt aCurPos);

	IMPORT_C virtual void MParser_Reserved_2();

	//++ ADD COMMENT HERE (poss. provide default implement that panics)
	virtual void Release() = 0;
	};

#endif