/* ***** BEGIN LICENSE BLOCK *****
 * Source last modified: $Id: atocolor.h,v 1.1.2.1 2004/07/09 01:50:15 hubbe Exp $
 * 
 * Portions Copyright (c) 1995-2004 RealNetworks, Inc. All Rights Reserved.
 * 
 * The contents of this file, and the files included with this file,
 * are subject to the current version of the RealNetworks Public
 * Source License (the "RPSL") available at
 * http://www.helixcommunity.org/content/rpsl unless you have licensed
 * the file under the current version of the RealNetworks Community
 * Source License (the "RCSL") available at
 * http://www.helixcommunity.org/content/rcsl, in which case the RCSL
 * will apply. You may also obtain the license terms directly from
 * RealNetworks.  You may not use this file except in compliance with
 * the RPSL or, if you have a valid RCSL with RealNetworks applicable
 * to this file, the RCSL.  Please see the applicable RPSL or RCSL for
 * the rights, obligations and limitations governing use of the
 * contents of the file.
 * 
 * Alternatively, the contents of this file may be used under the
 * terms of the GNU General Public License Version 2 or later (the
 * "GPL") in which case the provisions of the GPL are applicable
 * instead of those above. If you wish to allow use of your version of
 * this file only under the terms of the GPL, and not to allow others
 * to use your version of this file under the terms of either the RPSL
 * or RCSL, indicate your decision by deleting the provisions above
 * and replace them with the notice and other provisions required by
 * the GPL. If you do not delete the provisions above, a recipient may
 * use your version of this file under the terms of any one of the
 * RPSL, the RCSL or the GPL.
 * 
 * This file is part of the Helix DNA Technology. RealNetworks is the
 * developer of the Original Code and owns the copyrights in the
 * portions it created.
 * 
 * This file, and the files included with this file, is distributed
 * and made available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY
 * KIND, EITHER EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS
 * ALL SUCH WARRANTIES, INCLUDING WITHOUT LIMITATION, ANY WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, QUIET
 * ENJOYMENT OR NON-INFRINGEMENT.
 * 
 * Technology Compatibility Kit Test Suite(s) Location:
 *    http://www.helixcommunity.org/content/tck
 * 
 * Contributor(s):
 * 
 * ***** END LICENSE BLOCK ***** */

/////////////////////////////////////////////////////////////////////////////
//
//  ATOCOLOR.H
//
//
//  This file contains the functions that are used in RealText rendering to
//  convert a string of characters into a color (which in Windows is a
//  COLORTYPE)
//
//  (1)	BOOL convertColorNameToCOLORTYPE(
//		_CHAR* pColorName,
//		ULONG32 colorNameLen, 
//		COLORTYPE& colorVal);
//  //Converts a string, like "Darkblue", into a COLORTYPE value, like
//  //  0x00990000 (which is RGB(0,0,153) in Windows), and returns FALSE,
//  //  with colorVal undefined if colorName contains an unrecognized
//  //	color.  colorNameLen is equivalent of strlen(colorName), i.e.,
//  //	it does not take into account the terminating '\0' char.
//
//  (2) BOOL convertColorValStringToCOLORTYPE(
//		_CHAR* pColorVal,
//		ULONG32 colorValBufLen, 
//		COLORTYPE& colorVal);
//  //Converts a string like "#F71C00" to a COLORTYPE value, like
//  //  0x00001CF7 (which is RGB(F7,1C,00) in Windows), and returns
//  //  FALSE, with colorVal undefined if colorValBuf contains an
//  //  invalid value.  The leading '#' character is not necessary
//  //  because all values are assumed to be in Hexidecimal.
//
//

#if !defined(_ATOCOLOR_H_)
#define _ATOCOLOR_H_

#ifdef _WIN16
#define CLR_INVALID	0xffffffff
#endif

#define MIN_COLORNAMELENGTH	3	//is strlen("red").


#if !defined(_TMPTYPES_H_)
#include "rt_types.h"
#endif


/////////////////////////////////////////////////////////////////////////////
//
//  Converts a string, like "Darkblue", into a COLORTYPE value, like
//  0x00990000 (which is RGB(0,0,153) in Windows), and returns FALSE,
//  with colorVal undefined if colorName contains an unrecognized
//	color.  colorNameLen is equivalent of strlen(colorName), i.e.,
//	it does not take into account the terminating '\0' char.
//
BOOL convertColorNameToCOLORTYPE(
		_CHAR* pColorName,
		ULONG32 colorNameLen, 
		COLORTYPE& colorVal);

/////////////////////////////////////////////////////////////////////////////
//
//  Converts a string like "#F71C00" to a COLORTYPE value, like
//  0x00001CF7 (which is RGB(F7,1C,00) in Windows), and returns
//  FALSE, with colorVal undefined if colorValBuf contains an
//  invalid value.  The leading '#' character is not necessary
//  because all values are assumed to be in Hexidecimal.
//
BOOL convertColorValStringToCOLORTYPE(
		_CHAR* pColorValBuf,
		ULONG32 colorValBufLen, 
		COLORTYPE& colorVal);



#endif
