epoc32/include/ecam/ecamdirectviewfinder.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000 (2010-03-16)
branchSymbian2
changeset 2 2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2006-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
williamr@2
    18
/**
williamr@2
    19
 @file
williamr@2
    20
 @publishedAll
williamr@2
    21
 @released
williamr@2
    22
*/
williamr@2
    23
#ifndef  ECAMDIRECTVIEWFINDER_H
williamr@2
    24
#define  ECAMDIRECTVIEWFINDER_H
williamr@2
    25
williamr@2
    26
#include <e32base.h>
williamr@2
    27
#include <ecam.h>
williamr@2
    28
#include <ecam/ecamdirectviewfinderuids.hrh>
williamr@2
    29
williamr@2
    30
class MCameraDirectViewFinder;
williamr@2
    31
williamr@2
    32
/** 
williamr@2
    33
UID used to identify the CCameraDirectViewFinder API.
williamr@2
    34
williamr@2
    35
@see CCamera::CCameraDirectViewFinder
williamr@2
    36
*/
williamr@2
    37
static const TUid KECamDirectViewFinderUid 	= {KECamDirectViewFinderUidValue};
williamr@2
    38
williamr@2
    39
/** 
williamr@2
    40
CCamera direct view finder class is used to provide support for Direct View Finder functionalities like pause/resume.
williamr@2
    41
williamr@2
    42
@note This class is not intended for sub-classing and used to standardise existing
williamr@2
    43
       varieties of implementations.
williamr@2
    44
williamr@2
    45
@note   This class features are supposed to be meant for the direct viewfinder started using CCamera methods.
williamr@2
    46
williamr@2
    47
@note   If the class methods leave, the output type parameter value is not guaranteed to be valid.
williamr@2
    48
williamr@2
    49
@publishedAll
williamr@2
    50
@released
williamr@2
    51
*/
williamr@2
    52
class CCamera::CCameraDirectViewFinder : public CBase
williamr@2
    53
	{
williamr@2
    54
	/* so can use internal factory functions etc. */
williamr@2
    55
	friend class CCamera;
williamr@2
    56
williamr@2
    57
public:
williamr@2
    58
   
williamr@2
    59
	/** Specifies direct viewfinder state. */ 
williamr@2
    60
	enum TViewFinderState
williamr@2
    61
		{
williamr@2
    62
		/** View Finder is activated */  
williamr@2
    63
		EViewFinderActive, 	 
williamr@2
    64
		/** View Finder has been paused */
williamr@2
    65
		EViewFinderPause,	 
williamr@2
    66
		/** View Finder has been stopped or hasn't yet started. Default state. */
williamr@2
    67
		EViewFinderInActive
williamr@2
    68
		};
williamr@2
    69
	
williamr@2
    70
public:
williamr@2
    71
williamr@2
    72
	IMPORT_C static CCameraDirectViewFinder* NewL(CCamera& aOwner);
williamr@2
    73
williamr@2
    74
    IMPORT_C void PauseViewFinderDirectL();
williamr@2
    75
	IMPORT_C void ResumeViewFinderDirectL();
williamr@2
    76
	IMPORT_C TViewFinderState ViewFinderState() const;
williamr@2
    77
	
williamr@2
    78
	IMPORT_C ~CCameraDirectViewFinder();
williamr@2
    79
    
williamr@2
    80
private:
williamr@2
    81
	CCameraDirectViewFinder(CCamera& aOwner);
williamr@2
    82
	void ConstructL();
williamr@2
    83
	
williamr@2
    84
	void SetImplHandle();
williamr@2
    85
	
williamr@2
    86
private:	
williamr@2
    87
	CCamera&                	iOwner;
williamr@2
    88
	MCameraDirectViewFinder* 	iImpl;  // not owned
williamr@2
    89
   };		
williamr@2
    90
    
williamr@2
    91
#endif // ECAMDIRECTVIEWFINDER_H