epoc32/include/medobsrv.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.
     1 /*
     2 * Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description: 
    15 *
    16 */
    17 
    18 
    19 #ifndef __MEDOBSRV_H__
    20 #define __MEDOBSRV_H__
    21 
    22 #include <e32def.h>
    23 
    24 
    25 
    26 class MEditObserver
    27 /** 
    28 Specifies the mixin protocol for a rich text edit observer. 
    29 
    30 This class is implemented by controls which use a rich text (CRichText) object, 
    31 when it is possible for the text object to be changed from outside of the 
    32 control without the control's knowledge.
    33 
    34 An edit observer is a callback to the control from the CRichText object which 
    35 it has been set up to observe. The edit observer is set up using CRichText::SetEditObserver(). 
    36 @publishedAll
    37 @released
    38 */
    39 	{
    40 public:
    41 	// Observer function called by CRichText to signal changes to the text
    42 	// buffer within it. A pointer to this function must be passed in to
    43 	// a CRichText instance by <rich text instance>.SetEditObserver(<ptr>).
    44 	// aStart is the start position of the edit and aExtent is the number
    45 	// of characters added or, if negative, deleted after this position.
    46 	
    47 	
    48 	/** Observer function called by the CRichText object when the object is edited 
    49 	to give notification of changes to its text buffer. In this way, the control 
    50 	knows how the text object has changed and can reformat and redraw the text 
    51 	object appropriately.
    52 	
    53 	A pointer to the observer object must have been passed in to a CRichText instance 
    54 	using CRichText::SetEditObserver().
    55 	
    56 	@param aStart The start position of the edit. 
    57 	@param aExtent The number of characters added or, if negative, deleted after 
    58 	this position. */
    59 	virtual void EditObserver(TInt aStart, TInt aExtent) = 0;
    60 	};
    61 
    62 #endif