//===========================================================================//
// File:	GUITextObject.hpp                                                    //
// Project: Adept                                  //
//---------------------------------------------------------------------------//
//   Date    Who  Modification                                               //
// --------  ---  ---------------------------------------------------------- //
// 04/21/99  DPB  Initial coding.                                            //
//---------------------------------------------------------------------------//
// Copyright (C) 1998-1999, Virtual World Entertainment, Inc.                //
//                      PROPRIETARY AND CONFIDENTIAL                         //
//===========================================================================//

#pragma once

#include "Adept.hpp"
#include "Receiver.hpp"

namespace Adept 
{
	
	//##########################################################################
	//###########################    GUIObject   ###############################
	//##########################################################################
	//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	// The following helper classes must always be typedef'd or overriden by an
	// inheritor
	//
	typedef Receiver__ClassData					GUITextObject__ClassData;
	typedef Receiver__Message					GUITextObject__Message;

	//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

	class GUITextObject:
		public Receiver
	{
	
	//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	// Inheritance Support
	//
	public:
		typedef GUITextObject__ClassData			ClassData;
		typedef GUITextObject__Message				Message;

	//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	// Construction, Destruction, Testing
	//
	public:
		static void
			InitializeClass();
		static void
			TerminateClass();

		GUITextObject(
			ClassData *class_data,
			HGOSFONT3D font_handle,
			const char *display_string,
			int x_location,
			int y_location
		);

		GUITextObject(
			ClassData *class_data,
			Stuff::Page *instance_page
		);

		GUITextObject(
			ClassData *class_data,
			Stuff::MemoryStream *stream
		);

		virtual void
			Save(Stuff::MemoryStream *stream);

		~GUITextObject();

		void
      		TestInstance();
	
	//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	// Class Data support
	//
	public:
		static ClassData 
			*DefaultData;

	//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	// Simulation Functions
	//
	public:
		void
			DrawText();
		void
			HideText();
		void
			ShowText();

	//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	// Data Accesors
	//
	public:
		

	//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	// Data 
	//
	public:
		HGOSFONT3D
			textFont;
		const char
			*fontName;
		Stuff::Scalar
			textSize;
		RGBAColor
			textColor;
		bool
			isVisible,
			isWordWrap,
			isProportional,
			isBold,
			isItalic;
		Stuff::MString
			displayString;
		MString
			textObjectName;
		int
			xLocation,
			yLocation;


	};
}