genericservices/httputils/inc/UriCommon.h
changeset 0 e4d67989cc36
equal deleted inserted replaced
-1:000000000000 0:e4d67989cc36
       
     1 // Copyright (c) 2001-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 // Internal header file with common constants used by the implementations
       
    15 // of the uri classes TUriC??, CUri?? and TUriParser??.
       
    16 // 
       
    17 //
       
    18 
       
    19 /**
       
    20  @file UriCommon.h
       
    21  @publishedAll
       
    22  @released
       
    23 */
       
    24 
       
    25 #ifndef __URICOMMON_H__
       
    26 #define __URICOMMON_H__
       
    27 
       
    28 // System includes
       
    29 //
       
    30 #include <e32base.h>
       
    31 
       
    32 /** 
       
    33 	Enum defining a flag used to indicate file storage type (fixed drive or removable media).
       
    34 	@publishedAll
       
    35 	@released
       
    36 	@since 9.1	
       
    37  */
       
    38 enum TFileUriFlags
       
    39 	 {
       
    40 	 /** 
       
    41 	 	Indiacte the drive letter in the URI is to be replaced by the term "ext-media" 
       
    42 	  */
       
    43 	 EExtMedia   = 1
       
    44 	 };
       
    45  
       
    46 /** 
       
    47 	Enum used by GetFileNameL to specify what data is returned. 
       
    48 	@publishedAll
       
    49 	@released
       
    50 	@since 9.1	
       
    51  */
       
    52 enum TUriFileName
       
    53 	 {
       
    54 	 /**
       
    55 	 	Indicate a File URI is to be converted into a fully qualified file name. Will Leave if not used on a file URI 
       
    56 	  */
       
    57 	 EUriFileNameFull   = 0,
       
    58 	 /**
       
    59 	 	Indicate a the path component is to be converted into a file name with directories, but no drive. Behaviour is undefined for non-hierarchical  schemes 
       
    60 	  */
       
    61 	 EUriFileNamePath,
       
    62 	 /** 
       
    63 	 	Indicate just the name is to be converted into a file name, with no directories. Behaviour is undefined for non-hierarchical  schemes 
       
    64 	  */
       
    65 	 EUriFileNameTail 
       
    66 	 };
       
    67 
       
    68 /**
       
    69 	Enum defining the uri components.
       
    70 	@warning		The enum value EUriMaxComponents should not be used as it will
       
    71 	cause a panic.
       
    72 	@publishedAll
       
    73 	@released
       
    74 	@since 6.0
       
    75 */
       
    76 enum TUriComponent
       
    77 	{
       
    78 	/**
       
    79 		The scheme component specifier 
       
    80 	 */
       
    81 	EUriScheme,
       
    82 	/**
       
    83 		The userinfo component specifier 
       
    84 	 */
       
    85 	EUriUserinfo,
       
    86 	/**
       
    87 		The host component specifier 
       
    88 	 */
       
    89 	EUriHost,
       
    90 	/**
       
    91 		The port component specifier 
       
    92 	 */
       
    93 	EUriPort,
       
    94 	/**
       
    95 		 The path component specifier 
       
    96 	 */
       
    97 	EUriPath,
       
    98 	/**
       
    99 		 The query component specifier 
       
   100 	 */
       
   101 	EUriQuery,
       
   102 	/** 
       
   103 		The fragment component specifier 
       
   104 	 */
       
   105 	EUriFragment,
       
   106 	/** 
       
   107 		Do not use as a field specifier - will cause panic 
       
   108 	 */
       
   109 	EUriMaxComponents, 
       
   110 	/** 
       
   111 		The complete URI. Only use with DisplayFormL, otherwise will cause panic 
       
   112 	 */
       
   113 	EUriComplete = -1
       
   114 	};
       
   115 
       
   116 #endif	// __URICOMMON_H__