epoc32/include/mw/bif.h
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
     1.1 --- a/epoc32/include/mw/bif.h	Wed Mar 31 12:27:01 2010 +0100
     1.2 +++ b/epoc32/include/mw/bif.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -1,9 +1,9 @@
     1.4  // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5  // All rights reserved.
     1.6  // This component and the accompanying materials are made available
     1.7 -// 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
     1.8 +// under the terms of "Eclipse Public License v1.0"
     1.9  // which accompanies this distribution, and is available
    1.10 -// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.12  //
    1.13  // Initial Contributors:
    1.14  // Nokia Corporation - initial contribution.
    1.15 @@ -11,46 +11,42 @@
    1.16  // Contributors:
    1.17  //
    1.18  // Description:
    1.19 +// BIF.H
    1.20  //
    1.21 -
    1.22 +/**
    1.23 + * @file 
    1.24 + * BIO information file (BIF)
    1.25 + *
    1.26 + * @publishedAll
    1.27 + * @released
    1.28 + */
    1.29  #ifndef __BIF_H__
    1.30  #define __BIF_H__
    1.31  
    1.32  #include <apmrec.h>
    1.33  
    1.34  class CBifEntry;
    1.35 +		
    1.36 +/** 
    1.37 + * Maximum length of ID text field.
    1.38 + * @publishedAll
    1.39 + * @released
    1.40 + */
    1.41 +const TInt KMaxBioIdText=128;
    1.42  
    1.43 -//
    1.44 -// Constants
    1.45 -/** 2nd UID of BIF file stores. */
    1.46 -const TUid KUidBioInfoFile={0x10005233};		// unicode Uid, used as 2nd Uid of file store
    1.47 -/** Indicates that when opening the message no application should be launched. */
    1.48 -const TUid KUidBioUseNoApp={0x00000000};			
    1.49 -/** Indicates that when opened the message is to be viewed by the default application. */
    1.50 -const TUid KUidBioUseDefaultApp={0x100052b2};		
    1.51 -/** Maximum length of BIO_INFO_FILE description field. */
    1.52 -const TInt KMaxBioDescription=128;
    1.53 -/** Maximum length of ID text field. */
    1.54 -const TInt KMaxBioIdText=128;
    1.55 -/** Unused from v7.0.
    1.56 +/** Data types.
    1.57 + * Buffer to hold a BIF ID identifier text field.
    1.58 + * @publishedAll
    1.59 + * @released
    1.60 + */
    1.61 +typedef TBuf<KMaxBioIdText> TBioMsgIdText;
    1.62  
    1.63 -Previously, it specified the maximum length of a command line to BIFTOOL. */
    1.64 -const TInt KMaxBioCommandLine=256;
    1.65 -/** Maximum length of BIO_INFO_FILE file_extension field. */
    1.66 -const TInt KMaxBioFileExtension=10;
    1.67 -
    1.68 -//
    1.69 -// Data types
    1.70 -/** Buffer to hold a BIF ID identifier text field. */
    1.71 -typedef TBuf<KMaxBioIdText> TBioMsgIdText;
    1.72 -/** Unused from v7.0.
    1.73 -
    1.74 -Previously, it held a command line to BIFTOOL. */
    1.75 -typedef TBuf<KMaxBioCommandLine> TBioCommand;
    1.76 -
    1.77 -/** Identifies bearers for the BIF ID type field.
    1.78 -
    1.79 -It is the C++ equivalent of the resource enum ID_TYPE. */
    1.80 +/** Identifies bearers for the BIF ID type field. 
    1.81 + * It is the C++ equivalent of the resource enum ID_TYPE.
    1.82 + *
    1.83 + * @publishedAll
    1.84 + * @released
    1.85 + */
    1.86  enum TBioMsgIdType 
    1.87  	{
    1.88  	/** Unknown.
    1.89 @@ -90,10 +86,11 @@
    1.90  	EBioMsgIdWspSecure
    1.91  	};
    1.92  
    1.93 -/** Encapsulates an ID from a BIF (BIO_INFO_FILE). 
    1.94 -@internalTechnology
    1.95 -@released
    1.96 -*/
    1.97 +/** Encapsulates an ID from a BIF (BIO_INFO_FILE).
    1.98 + *
    1.99 + * @publishedAll
   1.100 + * @released
   1.101 + */
   1.102  class TBioMsgId 
   1.103  	{
   1.104  public: