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