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