epoc32/include/uricommon.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
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.

// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
// All rights reserved.
// This component and the accompanying materials are made available
// under the terms of "Eclipse Public License v1.0"
// which accompanies this distribution, and is available
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
//
// Initial Contributors:
// Nokia Corporation - initial contribution.
//
// Contributors:
//
// Description:
// Internal header file with common constants used by the implementations
// of the uri classes TUriC??, CUri?? and TUriParser??.
// 
//

/**
 @file UriCommon.h
 @publishedAll
 @released
*/

#ifndef __URICOMMON_H__
#define __URICOMMON_H__

// System includes
//
#include <e32base.h>

/** 
	Enum defining a flag used to indicate file storage type (fixed drive or removable media).
	@publishedAll
	@released
	@since 9.1	
 */
enum TFileUriFlags
	 {
	 /** 
	 	Indiacte the drive letter in the URI is to be replaced by the term "ext-media" 
	  */
	 EExtMedia   = 1
	 };
 
/** 
	Enum used by GetFileNameL to specify what data is returned. 
	@publishedAll
	@released
	@since 9.1	
 */
enum TUriFileName
	 {
	 /**
	 	Indicate a File URI is to be converted into a fully qualified file name. Will Leave if not used on a file URI 
	  */
	 EUriFileNameFull   = 0,
	 /**
	 	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 
	  */
	 EUriFileNamePath,
	 /** 
	 	Indicate just the name is to be converted into a file name, with no directories. Behaviour is undefined for non-hierarchical  schemes 
	  */
	 EUriFileNameTail 
	 };

/**
	Enum defining the uri components.
	@warning		The enum value EUriMaxComponents should not be used as it will
	cause a panic.
	@publishedAll
	@released
	@since 6.0
*/
enum TUriComponent
	{
	/**
		The scheme component specifier 
	 */
	EUriScheme,
	/**
		The userinfo component specifier 
	 */
	EUriUserinfo,
	/**
		The host component specifier 
	 */
	EUriHost,
	/**
		The port component specifier 
	 */
	EUriPort,
	/**
		 The path component specifier 
	 */
	EUriPath,
	/**
		 The query component specifier 
	 */
	EUriQuery,
	/** 
		The fragment component specifier 
	 */
	EUriFragment,
	/** 
		Do not use as a field specifier - will cause panic 
	 */
	EUriMaxComponents, 
	/** 
		The complete URI. Only use with DisplayFormL, otherwise will cause panic 
	 */
	EUriComplete = -1
	};

#endif	// __URICOMMON_H__