/** 
 * @file llpanelpick.h
 * @brief LLPanelPick class definition
 *
 * $LicenseInfo:firstyear=2004&license=viewergpl$
 * 
 * Copyright (c) 2004-2009, Linden Research, Inc.
 * 
 * Second Life Viewer Source Code
 * The source code in this file ("Source Code") is provided by Linden Lab
 * to you under the terms of the GNU General Public License, version 2.0
 * ("GPL"), unless you have obtained a separate licensing agreement
 * ("Other License"), formally executed by you and Linden Lab.  Terms of
 * the GPL can be found in doc/GPL-license.txt in this distribution, or
 * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
 * 
 * There are special exceptions to the terms and conditions of the GPL as
 * it is applied to this Source Code. View the full text of the exception
 * in the file doc/FLOSS-exception.txt in this software distribution, or
 * online at
 * http://secondlifegrid.net/programs/open_source/licensing/flossexception
 * 
 * By copying, modifying or distributing this software, you acknowledge
 * that you have read and understood your obligations described above,
 * and agree to abide by those obligations.
 * 
 * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
 * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
 * COMPLETENESS OR PERFORMANCE.
 * $/LicenseInfo$
 */

// Display of a "Top Pick" used both for the global top picks in the 
// Find directory, and also for each individual user's picks in their
// profile.

#ifndef LL_LLPANELPICK_H
#define LL_LLPANELPICK_H

#include "llpanel.h"
#include "llremoteparcelrequest.h"

class LLTextureCtrl;
class LLMessageSystem;
class LLAvatarPropertiesObserver;

class LLPanelPick : public LLPanel, public LLAvatarPropertiesObserver, LLRemoteParcelInfoObserver
{
	LOG_CLASS(LLPanelPick);
public:
	LLPanelPick(BOOL edit_mode = FALSE);
	/*virtual*/ ~LLPanelPick();

	// switches the panel to the VIEW mode and resets controls
	void reset();

	/*virtual*/ BOOL postBuild();

	// Prepares a new pick, including creating an id, giving a sane
	// initial position, etc (saved on clicking Save Pick button - onClickSave callback).
	void prepareNewPick();
	void prepareNewPick(const LLVector3d pos_global,
					   const std::string& name,
					   const std::string& desc,
					   const LLUUID& snapshot_id,
					   const LLUUID& parcel_id);

	//initializes the panel with data of the pick with id = pick_id 
	//owned by the avatar with id = creator_id
	void init(LLUUID creator_id, LLUUID pick_id);

	/*virtual*/ void processProperties(void* data, EAvatarProcessorType type);

	// switches the panel to either View or Edit mode
	void setEditMode(BOOL edit_mode);

	void onPickChanged(LLUICtrl* ctrl);

	// because this panel works in two modes (edit/view) we are  
	// free from managing two panel for editing and viewing picks and so
	// are free from controlling switching between them in the parent panel (e.g. Me Profile)
	// but that causes such a complication that we cannot set a callback for a "Back" button
	// from the parent panel only once, so we have to preserve that callback
	// in the pick panel and set it for the back button everytime postBuild() is called.
	void setExitCallback(commit_callback_t cb);

	static void teleport(const LLVector3d& position);
	static void showOnMap(const LLVector3d& position);

	//This stuff we got from LLRemoteParcelObserver, in the last two we intentionally do nothing
	/*virtual*/ void processParcelInfo(const LLParcelData& parcel_data);
	/*virtual*/ void setParcelID(const LLUUID& parcel_id) {};
	/*virtual*/ void setErrorStatus(U32 status, const std::string& reason) {};

protected:

	/** 
	* "Location text" is actually the owner name, the original
	* name that owner gave the parcel, and the location.
	*/
	static std::string createLocationText(const std::string& owner_name, const std::string& original_name,
		const std::string& sim_name, const LLVector3d& pos_global);

	void setPickName(std::string name);
	void setPickDesc(std::string desc);
	void setPickLocation(const std::string& location);

	std::string getPickName();
	std::string getPickDesc();
	std::string getPickLocation();

	void sendUpdate();
	void requestData();

	void init(LLPickData *pick_data);

	void updateButtons();

	//-----------------------------------------
	// "PICK INFO" (VIEW MODE) BUTTON HANDLERS
	//-----------------------------------------
	void onClickEdit();
	void onClickTeleport();
	void onClickMap();

	//-----------------------------------------
	// "EDIT PICK" (EDIT MODE) BUTTON HANDLERS
	//-----------------------------------------
	void onClickSet();
	void onClickSave();
	void onClickCancel();

	void enableSaveButton(bool enable);

protected:
	BOOL mEditMode;
	LLTextureCtrl*	mSnapshotCtrl;
	BOOL mDataReceived;
	bool mIsPickNew;

	LLUUID mPickId;
	LLUUID mCreatorId;
	LLVector3d mPosGlobal;
	LLUUID mParcelId;
	std::string mSimName;

	//These strings are used to keep non-wrapped text
	std::string mName;
	std::string mDesc;
	std::string mLocation;

	commit_callback_t mBackCb;
	bool mLocationChanged;
};

#endif // LL_LLPANELPICK_H