// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
// All rights reserved.
// This component and the accompanying materials are made available
// under the terms of "Eclipse Public License v1.0"
// which accompanies this distribution, and is available
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
//
// Initial Contributors:
// Nokia Corporation - initial contribution.
//
// Contributors:
//
// Description:
// Contents :  fax s/r header file
// 
//

/**
 @file
*/

#ifndef __cfax32_h
#define __cfax32_h

/********************************************************************/

/********************************************************************/

// These are the other include files used when sending and receiving
// faxes.  The order of inclusion should not be changed.  Unfortunately,
// the design of the engine means that there's a very close coupling
// between the various classes involved, and while each class doesn't
// need to know how the other work, they all need to know what the others
// have to offer.  The fax settings need to be accessible from modem for
// autodetection to work, and since the modem handles the session log
// and progress reporting, the the cfaxtransfersource and
// cfaxmodemdriver classes need to be able know about that.  The inline
// functions at the end of this faxtrans.h file clearly won't compile if
// they don't know about cfaxtransfersource either. Ah well. So much for
// neat modular encapsulation.


#include <f32file.h>

#include <c32comm.h>
#include <s32file.h>
#include <s32mem.h>

#include <cdblen.h> 
#include <faxstore.h>
#include <faxdefn.h>

 #include <dial_consts.h>

#include <etel.h>
#include <faxtsrc.h>
#include <faxset.h>
#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
#include <faxsettings.h>
#endif
#include <faxstd.h>

/********************************************************************/

// now the CFaxTransfer class


//***************************** comment for 2D faxing****************************
// The TFaxCompression parameter required by the AddSourceL() function is an enum type defined as 
// enum TFaxCompression
//		{
//		Prefer1D,Prefer2D
//		}
// this enum is defined in faxtsrc.h

/**
@publishedPartner
*/
enum TFaxClientProgress
	{
	EProgressConverting,	// Fax Progress Information not yet available
	EProgressRxTx			// Refer to Fax Progress Chunck for more detailed information
	};

/**
Send or receive a fax

Contains the public Fax Client API.

The API includes a number of functions for setting up a fax, and then for 
sending it. Functions to set up a fax allow the client to launch a fax client 
session, set the fax mode, set the fax destination number, define the fax 
pages to be sent, and declare a file in which received faxes are to be stored. 
After setting up, the client can send, cancel and monitor the progress of 
the fax. 

This class is not intended for user derivation. 

@publishedPartner
@released
*/
class CFaxTransfer : public CBase
	{
public:
	~CFaxTransfer ();							//< destructor
	IMPORT_C static CFaxTransfer * NewL (const TFaxSettings &);
	IMPORT_C static CFaxTransfer * NewLC (const TFaxSettings &);

	IMPORT_C TInt Start (TRequestStatus &);		// starts the Fax Client thread		
	IMPORT_C TInt Progress ();					// Gets the progress of the fax session (updates the global progress chunk
	IMPORT_C void SetPhoneNumberL (TDesC8 &);	// sets the phone number to dial to
	IMPORT_C void Cancel ();					// cancels the fax session
	IMPORT_C void Stop ();						// calls Close() to the thread handle

	IMPORT_C void AddSourceL (const TFileName &,TFaxPreferredCompression=Prefer1D);			// TFaxPreferredCompression can be 
	IMPORT_C void AddSourceL (const TFileName &, TInt, TFaxPreferredCompression=Prefer1D);   // one of Prefer1D or Prefer2D
	IMPORT_C void AddSourceL (const TFileName &, TInt, TInt, TFaxPreferredCompression=Prefer1D);	// use this function to 
																			// indicate the fax document for sending
	IMPORT_C void RemoveAllSources ();						// Remove all fax pages from the sent list
	inline void SetReceiveFileName (const TFileName &);		// Set the name of the filename for fax reception
	inline void SetMode (TFaxMode);
	inline void SetPhoneNumber (TDesC8 &);
	inline void SetCallObjectName(TDesC& aName);
	TInt GetPhoneInfoForTsy(const TDes& aTsyName, RTelServer::TPhoneInfo& aPhoneInfo) const;
	void GetPhoneModuleNameL(TDes& aModuleName) const;
	void FaxReceiveL ();		
	void FaxTransmitL ();

	TFaxClientProgress iFaxClientProgress;
	RTelServer iTelServer;
	RLine iLine ;
	RCall iCall ;
	RPhone iPhone ;
	RFax iFax ;
	TBool iFaxStarted;
	CFaxTransferSource * iSource;
	TFaxMode iMode;

	/** The fax progress. 
	There are a number of data members with public access, 
	however only the progress information variable is part 
	of the public API.
	*/
	RFax::TProgress iProgress ;
	RCall::TFaxSessionSettings iFaxSessionSettings;
	TName iCallName;		

protected:
	RThread iDriverThread;						// fax client thread handle
//	RThread iConverterThread;
	CFaxTransfer();								// CFaxTransfer Constructor
	TBool iConverting;							// flag used when preparing the 2D version of the fax document
	TRequestStatus iTransferStatus ;			// status of the fax data transfer
	TRequestStatus iClientCancel;				// status of the cancel request
	TBuf8 < KMaxFaxBuf > iDataBuf;				// buffer to store 
	TFaxSettings iFaxSettings;
	TFileName iReceiveFileName ;				// only used when receiving
	TBuf<KMaxDialString> iPhoneNumber ; 		// only used when dialling
	void Convert2dL ();		// convert from 1D to 2D
	void Convert1dL ();		// convert from 2D to 1D


	TInt StartThread();
	void ConstructL (const TFaxSettings &);
	void CancelFaxServerSession ();
	void SetFaxSettingsL();
	void SetSharedFileHandlesL();
	};

#include <cfax32.inl>

#endif