/** 
 * @file lltoggleablemenu.h
 * @brief Menu toggled by a button press
 *
 * $LicenseInfo:firstyear=2009&license=viewergpl$
 * 
 * Copyright (c) 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_LLTOGGLEABLEMENU_H
#define LL_LLTOGGLEABLEMENU_H

#include "llmenugl.h"

class LLToggleableMenu : public LLMenuGL
{
public:
    //adding blank params to work around registration issue
    //where LLToggleableMenu was owning the LLMenuGL param
    //and menu.xml was never loaded
	struct Params : public LLInitParam::Block<Params, LLMenuGL::Params>
	{};
protected:
	LLToggleableMenu(const Params&);
	friend class LLUICtrlFactory;
public:
	virtual void handleVisibilityChange (BOOL curVisibilityIn);

	const LLRect& getButtonRect() const { return mButtonRect; }

	// Converts the given local button rect to a screen rect
	void setButtonRect(const LLRect& rect, LLView* current_view);
	void setButtonRect(LLView* current_view);

	// Returns "true" if menu was not closed by button click
	// and is not still visible. If menu is visible toggles
	// its visibility off.
	bool toggleVisibility();
	
protected:
	bool mClosedByButtonClick;
	LLRect mButtonRect;
};

#endif // LL_LLTOGGLEABLEMENU_H