BansheeEngine/Source/BansheeEngine/Include/BsGUIContextMenu.h

//********************************** Banshee Engine (www.banshee3d.com) **************************************************//
//**************** Copyright (c) 2016 Marko Pintera ([email protected]). All rights reserved. **********************//
#pragma once

#include "BsPrerequisites.h"
#include "BsGUIMenu.h"

namespace BansheeEngine
{
	/** @addtogroup GUI
	 *  @{
	 */

	/**
	 * Manages display and logic for a context menu. Context menus can be opened anywhere within the GUI and can contain a
	 * hierarchy of menu items. 
	 */
	class BS_EXPORT GUIContextMenu : public GUIMenu
	{
	public:
		GUIContextMenu();
		~GUIContextMenu();

		/** Opens a context menu at the specified position relative to the provided widget. */
		void open(const Vector2I& position, GUIWidget& widget);

	private:
		/**	Closes the context menu if open. */
		void close();

		/**	
		 * Called when the context menu is closed externally (for example when user selects an item or clicks outside it). 
		 */
		void onMenuClosed();

	private:
		bool mContextMenuOpen;
	};

	/** @} */
}