/** 
 * @file lldockablefloater.h
 * @brief Creates a panel of a specific kind for a toast.
 *
 * $LicenseInfo:firstyear=2003&license=viewergpl$
 * 
 * Copyright (c) 2003-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$
 */

#ifndef LL_DOCKABLEFLOATER_H
#define LL_DOCKABLEFLOATER_H

#include "llerror.h"
#include "llfloater.h"
#include "lldockcontrol.h"

/**
 * Represents floater that can dock.
 * In case impossibility deriving from LLDockableFloater use LLDockControl.
 */
class LLDockableFloater : public LLFloater
{
	static const U32 UNDOCK_LEAP_HEIGHT = 12;

	static void init(LLDockableFloater* thiz);
public:
	LOG_CLASS(LLDockableFloater);
	LLDockableFloater(LLDockControl* dockControl, const LLSD& key,
			const Params& params = getDefaultParams());

	/**
	 * Constructor.
	 * @param dockControl a pointer to the doc control instance
	 * @param uniqueDocking - a flag defines is docking should work as tab(at one
	 * moment only one docked floater can be shown), also this flag defines is dock
	 * tongue should be used.
	 * @params key a floater key.
 	 * @params params a floater parameters
	 */
	LLDockableFloater(LLDockControl* dockControl, bool uniqueDocking,
			const LLSD& key, const Params& params = getDefaultParams());

	/**
	 * Constructor.
	 * @param dockControl a pointer to the doc control instance
	 * @param uniqueDocking - a flag defines is docking should work as tab(at one
	 * moment only one docked floater can be shown).
	 * @praram useTongue - a flag defines is dock tongue should be used.
	 * @params key a floater key.
 	 * @params params a floater parameters
	 */
	LLDockableFloater(LLDockControl* dockControl, bool uniqueDocking,
			bool useTongue, const LLSD& key,
			const Params& params = getDefaultParams());

	virtual ~LLDockableFloater();

	static LLHandle<LLFloater> getInstanceHandle() { return sInstanceHandle; }

	static void toggleInstance(const LLSD& sdname);

	/**
	 *  If descendant class overrides postBuild() in order to perform specific
	 *  construction then it must still invoke its superclass' implementation.
	 */
	/* virtula */BOOL postBuild();
	/* virtual */void setDocked(bool docked, bool pop_on_undock = true);
	/* virtual */void draw();

	/**
	 *  If descendant class overrides setVisible() then it must still invoke its
	 *  superclass' implementation.
	 */
	/*virtual*/ void setVisible(BOOL visible);

	/**
	 *  If descendant class overrides setMinimized() then it must still invoke its
	 *  superclass' implementation.
	 */
	/*virtual*/ void setMinimized(BOOL minimize);

	LLView * getDockWidget();

	virtual void onDockHidden();
	virtual void onDockShown();

	LLDockControl* getDockControl();

	/**
	 * Returns true if screen channel should consider floater's size when drawing toasts.
	 *
	 * By default returns false.
	 */
	virtual bool overlapsScreenChannel() { return mOverlapsScreenChannel && getVisible() && isDocked(); }
	virtual void setOverlapsScreenChannel(bool overlaps) { mOverlapsScreenChannel = overlaps; }

	bool getUniqueDocking() { return mUniqueDocking;	}
	bool getUseTongue() { return mUseTongue; }
private:
	/**
	 * Provides unique of dockable floater.
	 * If dockable floater already exists it should  be closed.
	 */
	void resetInstance();

protected:
	void setDockControl(LLDockControl* dockControl);
	const LLUIImagePtr& getDockTongue();

private:
	std::auto_ptr<LLDockControl> mDockControl;
	LLUIImagePtr mDockTongue;
	static LLHandle<LLFloater> sInstanceHandle;
	/**
	 * Provides possibility to define that dockable floaters can be docked
	 *  non exclusively.
	 */
	bool mUniqueDocking;

	bool mUseTongue;

	bool mOverlapsScreenChannel;
};

#endif /* LL_DOCKABLEFLOATER_H */