epoc32/include/icl/imageconstruct.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.
williamr@2
     1
williamr@2
     2
// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
// All rights reserved.
williamr@2
     4
// This component and the accompanying materials are made available
williamr@4
     5
// under the terms of "Eclipse Public License v1.0"
williamr@2
     6
// which accompanies this distribution, and is available
williamr@4
     7
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
//
williamr@2
     9
// Initial Contributors:
williamr@2
    10
// Nokia Corporation - initial contribution.
williamr@2
    11
//
williamr@2
    12
// Contributors:
williamr@2
    13
//
williamr@2
    14
// Description:
williamr@2
    15
// ImageConstruct.h - classes used during construction of decoders/encoders
williamr@2
    16
// 
williamr@2
    17
//
williamr@2
    18
williamr@2
    19
#ifndef __ImageConstruct_h
williamr@2
    20
#define __ImageConstruct_h
williamr@2
    21
williamr@2
    22
#include <e32base.h>
williamr@2
    23
williamr@2
    24
// forward declarations
williamr@2
    25
class CImageDecoder;
williamr@2
    26
class CImageDecoderPlugin;
williamr@2
    27
class CImageEncoder;
williamr@2
    28
class CImageEncoderPlugin;
williamr@2
    29
class RCImageDecodeConstructTest;
williamr@2
    30
class RCImageEncodeConstructTest;
williamr@2
    31
williamr@2
    32
/**
williamr@2
    33
@publishedAll
williamr@2
    34
@released
williamr@2
    35
williamr@2
    36
Provides functions related to constructing decoders.
williamr@2
    37
williamr@2
    38
Objects of this class are loaded by ECOM, and it is this class which
williamr@2
    39
is responsible for instantiating the decoder plugins. Plugin writers
williamr@2
    40
must derive their own plugin specific variants. The derived class
williamr@2
    41
is responsible for defining its own factory function to create instances
williamr@2
    42
of itself.
williamr@2
    43
*/
williamr@2
    44
williamr@2
    45
class CImageDecodeConstruct : public CBase
williamr@2
    46
	{
williamr@2
    47
	friend class CImageDecoder;
williamr@2
    48
public:
williamr@2
    49
	IMPORT_C ~CImageDecodeConstruct();
williamr@2
    50
williamr@2
    51
	IMPORT_C TUid ImplementationUid() const;
williamr@2
    52
	// create new CImageDecoder - default creates basic CImageDecoder
williamr@2
    53
	IMPORT_C virtual CImageDecoder* NewDecoderL() const;
williamr@2
    54
williamr@2
    55
	/**
williamr@2
    56
	Creates a new concrete CImageDecoderPlugin object.
williamr@2
    57
williamr@2
    58
	This is a pure virtual function that each derived class must implement.
williamr@2
    59
williamr@2
    60
	@return A pointer to a fully constructed CImageDecoderPlugin.
williamr@2
    61
	*/
williamr@2
    62
	virtual CImageDecoderPlugin* NewPluginL() const = 0;
williamr@2
    63
williamr@2
    64
	// request threaded decode - default false
williamr@2
    65
	IMPORT_C virtual TBool RequestThread() const;
williamr@2
    66
protected:
williamr@2
    67
	IMPORT_C CImageDecodeConstruct();
williamr@2
    68
	IMPORT_C void ConstructL();
williamr@2
    69
williamr@2
    70
private:
williamr@2
    71
	IMPORT_C virtual void ReservedVirtual1();
williamr@2
    72
	IMPORT_C virtual void ReservedVirtual2();
williamr@2
    73
	IMPORT_C virtual void ReservedVirtual3();
williamr@2
    74
	IMPORT_C virtual void ReservedVirtual4();
williamr@2
    75
private:
williamr@2
    76
	/**
williamr@2
    77
	This member is internal and not intended for use.
williamr@2
    78
	*/
williamr@2
    79
	TUid iDtorIDKey;
williamr@2
    80
williamr@2
    81
	/**
williamr@2
    82
	This member is internal and not intended for use.
williamr@2
    83
	*/
williamr@2
    84
	TAny* iReserved;
williamr@2
    85
williamr@2
    86
friend class RCImageDecodeConstructTest;
williamr@2
    87
	};
williamr@2
    88
williamr@2
    89
/**
williamr@2
    90
@publishedAll
williamr@2
    91
@released
williamr@2
    92
williamr@2
    93
Provides functions related to constructing encoders.
williamr@2
    94
williamr@2
    95
Objects of this class are loaded by ECOM, and it is this class which
williamr@2
    96
is responsible for instantiating the encoder plugins. Plugin writers
williamr@2
    97
must derive their own plugin specific variants. The derived class
williamr@2
    98
is responsible for defining its own factory function to create instances
williamr@2
    99
of itself.
williamr@2
   100
*/
williamr@2
   101
class CImageEncodeConstruct : public CBase
williamr@2
   102
	{
williamr@2
   103
	friend class CImageEncoder;
williamr@2
   104
public:
williamr@2
   105
	IMPORT_C ~CImageEncodeConstruct();
williamr@2
   106
williamr@2
   107
	IMPORT_C TUid ImplementationUid() const;
williamr@2
   108
	// create new CImageEncoder - default creates basic CImageEncoder
williamr@2
   109
	IMPORT_C virtual CImageEncoder* NewEncoderL() const;
williamr@2
   110
williamr@2
   111
	/**
williamr@2
   112
	Creates new concrete CImageEncoderPlugin object.
williamr@2
   113
williamr@2
   114
	This is a virtual function that each derived class must implement.
williamr@2
   115
williamr@2
   116
	@return A pointer to fully constructed CImageEncoderPlugin.
williamr@2
   117
	*/
williamr@2
   118
	virtual CImageEncoderPlugin* NewPluginL() const = 0;
williamr@2
   119
williamr@2
   120
	// request threaded encode - default false
williamr@2
   121
	IMPORT_C virtual TBool RequestThread() const;
williamr@2
   122
protected:
williamr@2
   123
	IMPORT_C CImageEncodeConstruct();
williamr@2
   124
	IMPORT_C void ConstructL();
williamr@2
   125
williamr@2
   126
private:
williamr@2
   127
	IMPORT_C virtual void ReservedVirtual1();
williamr@2
   128
	IMPORT_C virtual void ReservedVirtual2();
williamr@2
   129
	IMPORT_C virtual void ReservedVirtual3();
williamr@2
   130
	IMPORT_C virtual void ReservedVirtual4();
williamr@2
   131
private:
williamr@2
   132
	TUid iDtorIDKey;
williamr@2
   133
	TAny* iReserved;
williamr@2
   134
friend class RCImageEncodeConstructTest;
williamr@2
   135
	};
williamr@2
   136
williamr@2
   137
#endif //__ImageConstruct_h