1 eikpicturefactory.h

     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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 //

    15 

    16 

    17 #ifndef __EIKPICTUREFACTORY_H__

    18 #define __EIKPICTUREFACTORY_H__

    19 

    20 #include <e32std.h>		// class TUid

    21 #include <gdi.h>		// class TPictureHeader;

    22 

    23 

    24 /** Provides the support for embedding something other than a CApaDoor. 

    25 

    26 @publishedAll 

    27 @released */

    28 class MEikPictureFactory

    29 	{

    30 public:

    31 	IMPORT_C virtual TUid Id() const;

    32 	/** Tests if the factory supports the specified picture type.

    33 	

    34 	@param aPictureType The picture type.

    35 	@return ETrue if the factory supports the specified picture type, otherwise 

    36 	EFalse. */

    37 	virtual TBool SupportsPictureType(TUid aPictureType) const=0;

    38 	/** Gets a pointer to the picture factory.

    39 	

    40 	Use of this function does not transfer ownership of the picture factory to 

    41 	the caller.

    42 	

    43 	@param aPictureType The picture type.

    44 	@return Pointer to the picture factory. */

    45 	virtual const MPictureFactory* PictureFactory(TUid aPictureType) const=0;

    46 	/** Inserts a new picture object. 

    47 	

    48 	Ownership of aData transfers immediately the function is called.

    49 	

    50 	@param aPictureType The picture type.

    51 	@param aData The base address of the data.

    52 	@return The picture header. */

    53 	virtual TPictureHeader InsertL(TUid aPictureType, CBase* aData)=0;

    54 	/** Enables editing/viewing of an object

    55 	

    56 	@param aPictureHeader The picture header.

    57 	@param aReadOnly ETrue if object is read only, otherwise EFalse. */

    58 	virtual void EditL(const TPictureHeader& aPictureHeader, TBool aReadOnly)=0;

    59 private:

    60 	IMPORT_C virtual void MEikPictureFactory_Reserved_1();

    61 	IMPORT_C virtual void MEikPictureFactory_Reserved_2();

    62 	};

    63 

    64 

    65 #endif 	// __EIKPICTUREFACTORY_H__