BansheeEngine/Source/BansheeEngine/GUI/BsGUITooltip.h

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

#include "BsPrerequisites.h"
#include "GUI/BsCGUIWidget.h"

namespace bs
{
	/** @addtogroup GUI-Internal
	 *  @{
	 */

	/**	GUI widget that renders a tooltip overlaid over other GUI elements. */
	class BS_EXPORT GUITooltip : public CGUIWidget
	{
	public:
		/**	Name of the style used for tooltip's background frame. */
		static String getFrameStyleName();

		/**
		 * Creates a new tooltip widget.
		 *
		 * @param[in]	parent			Parent scene object to attach the tooltip to.
		 * @param[in]	overlaidWidget	Widget over which to overlay the tooltip.
		 * @param[in]	position		Position of the tooltip, relative to the overlaid widget position.
		 * @param[in]	text			Text to display in the tooltip.
		 */
		GUITooltip(const HSceneObject& parent, const GUIWidget& overlaidWidget, const Vector2I& position, const WString& text);
		~GUITooltip();

	private:
		static const UINT32 TOOLTIP_WIDTH;
		static const UINT32 CURSOR_SIZE;
	};

	/** @} */
}