epoc32/include/uricommon.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.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 
    21 /**
    22  @file UriCommon.h
    23  @publishedAll
    24  @released
    25 */
    26 
    27 #ifndef __URICOMMON_H__
    28 #define __URICOMMON_H__
    29 
    30 // System includes
    31 //
    32 #include <e32base.h>
    33 
    34 /** 
    35 	Enum defining a flag used to indicate file storage type (fixed drive or removable media).
    36 	@publishedAll
    37 	@released
    38 	@since 9.1	
    39  */
    40 enum TFileUriFlags
    41 	 {
    42 	 /** 
    43 	 	Indiacte the drive letter in the URI is to be replaced by the term "ext-media" 
    44 	  */
    45 	 EExtMedia   = 1
    46 	 };
    47  
    48 /** 
    49 	Enum used by GetFileNameL to specify what data is returned. 
    50 	@publishedAll
    51 	@released
    52 	@since 9.1	
    53  */
    54 enum TUriFileName
    55 	 {
    56 	 /**
    57 	 	Indicate a File URI is to be converted into a fully qualified file name. Will Leave if not used on a file URI 
    58 	  */
    59 	 EUriFileNameFull   = 0,
    60 	 /**
    61 	 	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 
    62 	  */
    63 	 EUriFileNamePath,
    64 	 /** 
    65 	 	Indicate just the name is to be converted into a file name, with no directories. Behaviour is undefined for non-hierarchical  schemes 
    66 	  */
    67 	 EUriFileNameTail 
    68 	 };
    69 
    70 /**
    71 	Enum defining the uri components.
    72 	@warning		The enum value EUriMaxComponents should not be used as it will
    73 	cause a panic.
    74 	@publishedAll
    75 	@released
    76 	@since 6.0
    77 */
    78 enum TUriComponent
    79 	{
    80 	/**
    81 		The scheme component specifier 
    82 	 */
    83 	EUriScheme,
    84 	/**
    85 		The userinfo component specifier 
    86 	 */
    87 	EUriUserinfo,
    88 	/**
    89 		The host component specifier 
    90 	 */
    91 	EUriHost,
    92 	/**
    93 		The port component specifier 
    94 	 */
    95 	EUriPort,
    96 	/**
    97 		 The path component specifier 
    98 	 */
    99 	EUriPath,
   100 	/**
   101 		 The query component specifier 
   102 	 */
   103 	EUriQuery,
   104 	/** 
   105 		The fragment component specifier 
   106 	 */
   107 	EUriFragment,
   108 	/** 
   109 		Do not use as a field specifier - will cause panic 
   110 	 */
   111 	EUriMaxComponents, 
   112 	/** 
   113 		The complete URI. Only use with DisplayFormL, otherwise will cause panic 
   114 	 */
   115 	EUriComplete = -1
   116 	};
   117 
   118 #endif	// __URICOMMON_H__