epoc32/include/eikpicturefactory.h
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
//
williamr@2
    15
williamr@2
    16
williamr@2
    17
#ifndef __EIKPICTUREFACTORY_H__
williamr@2
    18
#define __EIKPICTUREFACTORY_H__
williamr@2
    19
williamr@2
    20
#include <e32std.h>		// class TUid
williamr@2
    21
#include <gdi.h>		// class TPictureHeader;
williamr@2
    22
williamr@2
    23
williamr@2
    24
/** Provides the support for embedding something other than a CApaDoor. 
williamr@2
    25
williamr@2
    26
@publishedAll 
williamr@2
    27
@released */
williamr@2
    28
class MEikPictureFactory
williamr@2
    29
	{
williamr@2
    30
public:
williamr@2
    31
	IMPORT_C virtual TUid Id() const;
williamr@2
    32
	/** Tests if the factory supports the specified picture type.
williamr@2
    33
	
williamr@2
    34
	@param aPictureType The picture type.
williamr@2
    35
	@return ETrue if the factory supports the specified picture type, otherwise 
williamr@2
    36
	EFalse. */
williamr@2
    37
	virtual TBool SupportsPictureType(TUid aPictureType) const=0;
williamr@2
    38
	/** Gets a pointer to the picture factory.
williamr@2
    39
	
williamr@2
    40
	Use of this function does not transfer ownership of the picture factory to 
williamr@2
    41
	the caller.
williamr@2
    42
	
williamr@2
    43
	@param aPictureType The picture type.
williamr@2
    44
	@return Pointer to the picture factory. */
williamr@2
    45
	virtual const MPictureFactory* PictureFactory(TUid aPictureType) const=0;
williamr@2
    46
	/** Inserts a new picture object. 
williamr@2
    47
	
williamr@2
    48
	Ownership of aData transfers immediately the function is called.
williamr@2
    49
	
williamr@2
    50
	@param aPictureType The picture type.
williamr@2
    51
	@param aData The base address of the data.
williamr@2
    52
	@return The picture header. */
williamr@2
    53
	virtual TPictureHeader InsertL(TUid aPictureType, CBase* aData)=0;
williamr@2
    54
	/** Enables editing/viewing of an object
williamr@2
    55
	
williamr@2
    56
	@param aPictureHeader The picture header.
williamr@2
    57
	@param aReadOnly ETrue if object is read only, otherwise EFalse. */
williamr@2
    58
	virtual void EditL(const TPictureHeader& aPictureHeader, TBool aReadOnly)=0;
williamr@2
    59
private:
williamr@2
    60
	IMPORT_C virtual void MEikPictureFactory_Reserved_1();
williamr@2
    61
	IMPORT_C virtual void MEikPictureFactory_Reserved_2();
williamr@2
    62
	};
williamr@2
    63
williamr@2
    64
williamr@2
    65
#endif 	// __EIKPICTUREFACTORY_H__