epoc32/include/faxdefn.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.
     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 "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 // FaxDefn Header
    15 // 
    16 //
    17 
    18 
    19 
    20 /**
    21  @file
    22  @publishedAll
    23  @released
    24 */
    25 
    26 #ifndef __FAXDEFN_H
    27 #define	__FAXDEFN_H
    28 
    29 #include <e32std.h>
    30 
    31 //
    32 // Fax class definition
    33 //
    34 /** Defines the fax modem classes supported by the fax client.
    35 
    36 The fax class refers to the command set used to control the modem. 
    37 
    38 @publishedAll
    39 @released
    40 */
    41 enum TFaxClass
    42 	{
    43 	/** Automatic detection of the fax modem class. */
    44 	EClassAuto=0,
    45 	/** Fax class 1 */
    46 	EClass1=1,
    47 	/** Fax class 2 */
    48 	EClass2=2,
    49 	/** Fax class 2.0 */
    50 	EClass2point0=4,
    51 	/** Fax class 1.0 */
    52 	EClass1point0=8,
    53 	/** Fax class 2.1 */
    54 	EClass2point1=16
    55 	};
    56 
    57 //
    58 // Fax phase definition
    59 //
    60 /** Fax session phases.
    61 
    62 Defines what is done if a fax session fails is dependent on the current phase. 
    63 @publishedAll
    64 @released
    65 */
    66 enum TFaxPhase
    67 	{
    68 	/** The session has not yet begun */
    69 	ENotYetStarted,
    70 	/** Phase 'A'. Establishing connection. */
    71 	ECallEstablishment='A',
    72 	/** Phase 'B'. Negotiating fax protocols. */
    73 	ESessionNegotiation='B',
    74 	/** Phase 'C'. Transferring information */
    75 	EDataTransfer='C',
    76 	/** Phase 'D'. Confirming successful send/receive. */
    77 	EPostPageStatus='D',
    78 	/** Phase 'E'. Disconnecting. */
    79 	EDisconnection='E'
    80 	};
    81 
    82 //
    83 // Fax resolution definition
    84 //
    85 /** Defines the supported fax resolutions. 
    86 
    87 It is also used by the fax store classes. 
    88 
    89 @publishedAll
    90 @released
    91 */
    92 enum TFaxResolution
    93 	{
    94 	/** Normal fax resolution 3.85 lines/mm */
    95 	EFaxNormal,
    96 	/** Fine fax resolution 7.7 lines/mm */
    97 	EFaxFine
    98 	};
    99 
   100 //
   101 // Fax compression definition
   102 //
   103 /** Defines the types of compression supported by the fax client.
   104 
   105 This enumeration is also used by the fax store classes. 
   106 
   107 @publishedAll
   108 @released
   109 */
   110 enum TFaxCompression
   111 	{
   112 	/** One-dimensional T.4 encoding. Also known as MH. */
   113 	EModifiedHuffman=0,
   114 	/** Two-dimensional T.4 encoding. Also known as MR. */
   115 	EModifiedRead=1,
   116 	/** Two-dimensional T.4 encoding including uncompressed mode. */
   117 	EUncompressedModifiedRead=2,
   118 	/** T.6 encoding. Not supported by the fax engine. Also known as MMR. */
   119 	EModifiedModifiedRead=3
   120 	};
   121 
   122 /**
   123 Scan Line Constants
   124 @publishedAll
   125 @released
   126 */
   127 const TInt KFaxPixelsPerScanLine(1728);
   128 const TInt KFaxBytesPerScanLine(216);	
   129 
   130 const TInt KFaxCmPerScanLine(215);
   131 const TInt KFaxScanLinesPer10Cm(385);
   132 const TInt KFaxFineScanLinesPer10Cm(770);
   133 const TInt KFaxT4MaxDesLength(896);
   134 const TInt KFaxLinesPerBand(64);
   135 
   136 /** Defines a buffer to hold a fax sender ID. */
   137 typedef TBuf<20> TFaxBufSenderId;
   138 /** Defines a raw scan line. 
   139 
   140 Each scan line is comprised of KFaxBytesPerScanLine (216) bytes. */
   141 typedef TBuf8 < KFaxBytesPerScanLine > TRawScanLine;
   142 
   143 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
   144 #include "fax_reversebytes.h"
   145 #endif
   146 
   147 #endif