/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 1998
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. 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 MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#ifndef __H_CInlineEditField
#define __H_CInlineEditField
#pragma once

/*======================================================================================
	AUTHOR:			Ted Morris <tmorris@netscape.com> - 19 SEP 96

	DESCRIPTION:	Defines a class for performing inline editing of text fields in a 
					view. Place an instance of this class into the view in Constructor.

	MODIFICATIONS:

	Date			Person			Description
	----			------			-----------
======================================================================================*/


/*====================================================================================*/
	#pragma mark INCLUDE FILES
/*====================================================================================*/

#include <LBroadcasterEditField.h>


#pragma mark -
/*====================================================================================*/
	#pragma mark TYPEDEFS
/*====================================================================================*/


#pragma mark -
/*====================================================================================*/
	#pragma mark CONSTANTS
/*====================================================================================*/


#pragma mark -
/*====================================================================================*/
	#pragma mark CLASS DECLARATIONS
/*====================================================================================*/

class CInlineEditField : public LBroadcasterEditField {


	typedef LBroadcasterEditField Inherited;


public:

						enum { class_ID = 'InEd' };

						CInlineEditField(LStream *inStream) :
										 LBroadcasterEditField(inStream),
										 mGivingUpTarget(false),
										 mGrowableBorder(false) {
							
							SetRefreshAllWhenResized(false);
						}
						
						// Broadcast messages
						
						enum {
							msg_HidingInlineEditField = 'hIeF'		// PaneIDT *, id of the inline edit field
																	// The edit field in losing the target and
																	// being hidden, update the real text field
																	// to the text contained in this edit field.
							
						,	msg_InlineEditFieldChanged = 'iEfC'		// PaneIDT *, The text of the inline edit field 
																	// has been modified by the user.
						};
						
						// Constants
						
						enum {
							cRefreshMargin = 3
						,	cEditBoxMargin = 2
						};
			
	virtual void		SetDescriptor(ConstStr255Param inDescriptor);
	
	virtual void		UpdateEdit(ConstStr255Param inEditText, const SPoint32 *inImageTopLeft,
								   SMouseDownEvent *ioMouseDown = nil);
								 
			void 		SetGrowableBorder(Boolean inGrowable);
			Boolean 	GetGrowableBorder();
	
protected:

	virtual void		FinishCreateSelf(void);
	virtual void		ResizeFrameBy(Int16 inWidthDelta, Int16 inHeightDelta, Boolean inRefresh);
	virtual Boolean		HandleKeyPress(const EventRecord &inKeyEvent);
	virtual void		DontBeTarget(void);
	virtual void		HideSelf(void);
	virtual void		TakeOffDuty(void);
	virtual void		UserChangedText(void);
	
	void				AdjustFrameWidthToText(void);
	
	// Instance variables
	
	Boolean				mGivingUpTarget;
	Boolean				mGrowableBorder;
	LStr255				mOriginalName;
};




#endif // __H_CInlineEditField