| 1 | //************************************ bs::framework - Copyright 2018 Marko Pintera **************************************// |
| 2 | //*********** Licensed under the MIT license. See LICENSE.md for full terms. This notice is not to be removed. ***********// |
| 3 | #pragma once |
| 4 | |
| 5 | #include "BsPrerequisites.h" |
| 6 | #include "Utility/BsModule.h" |
| 7 | |
| 8 | namespace bs |
| 9 | { |
| 10 | /** @addtogroup GUI-Internal |
| 11 | * @{ |
| 12 | */ |
| 13 | |
| 14 | /** Manages displaying tooltips over GUI elements. */ |
| 15 | class BS_EXPORT GUITooltipManager : public Module<GUITooltipManager> |
| 16 | { |
| 17 | public: |
| 18 | ~GUITooltipManager(); |
| 19 | |
| 20 | /** |
| 21 | * Shows a tooltip at the specified location. This will replace any previously shown tooltip. |
| 22 | * |
| 23 | * @param[in] widget GUI widget over which to display the tooltip. |
| 24 | * @param[in] position Position of the tooltip, relative to the parent GUI widget. |
| 25 | * @param[in] text Text to display on the tooltip. |
| 26 | */ |
| 27 | void show(const GUIWidget& widget, const Vector2I& position, const String& text); |
| 28 | |
| 29 | /** Hides the currently shown tooltip. */ |
| 30 | void hide(); |
| 31 | |
| 32 | private: |
| 33 | HSceneObject mTooltipSO; |
| 34 | }; |
| 35 | |
| 36 | /** @} */ |
| 37 | } |