Line data    Source code

       1             : /* Copyright (C) 2021 Wildfire Games.
       2             :  * This file is part of 0 A.D.
       3             :  *
       4             :  * 0 A.D. is free software: you can redistribute it and/or modify
       5             :  * it under the terms of the GNU General Public License as published by
       6             :  * the Free Software Foundation, either version 2 of the License, or
       7             :  * (at your option) any later version.
       8             :  *
       9             :  * 0 A.D. is distributed in the hope that it will be useful,
      10             :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      11             :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      12             :  * GNU General Public License for more details.
      13             :  *
      14             :  * You should have received a copy of the GNU General Public License
      15             :  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
      16             :  */
      17             : 
      18             : #ifndef INCLUDED_CTOOLTIP
      19             : #define INCLUDED_CTOOLTIP
      20             : 
      21             : #include "gui/CGUISprite.h"
      22             : #include "gui/ObjectBases/IGUIObject.h"
      23             : #include "gui/ObjectBases/IGUITextOwner.h"
      24             : #include "gui/SettingTypes/CGUIString.h"
      25             : #include "maths/Vector2D.h"
      26             : 
      27             : /**
      28             :  * Dynamic tooltips. Similar to CText.
      29             :  */
      30             : class CTooltip : public IGUIObject, public IGUITextOwner
      31             : {
      32           0 :     GUI_OBJECT(CTooltip)
      33             : 
      34             : public:
      35             :     CTooltip(CGUI& pGUI);
      36             :     virtual ~CTooltip();
      37             : 
      38           0 :     const CStr& GetUsedObject() const { return m_UseObject; }
      39           0 :     i32 GetTooltipDelay() const { return m_Delay; }
      40           0 :     bool ShouldHideObject() const { return m_HideObject; }
      41           0 :     void SetMousePos(const CVector2D& vec) { m_MousePos.Set(vec, true); }
      42             : 
      43             : protected:
      44             :     void SetupText();
      45             : 
      46             :     /**
      47             :      * @see IGUIObject#UpdateCachedSize()
      48             :      */
      49             :     void UpdateCachedSize();
      50             : 
      51             :     /**
      52             :      * @see IGUIObject#HandleMessage()
      53             :      */
      54             :     virtual void HandleMessage(SGUIMessage& Message);
      55             : 
      56             :     virtual void Draw(CCanvas2D& canvas);
      57             : 
      58             :     virtual float GetBufferedZ() const;
      59             : 
      60             :     CGUISimpleSetting<float> m_BufferZone;
      61             :     CGUISimpleSetting<CGUIString> m_Caption;
      62             :     CGUISimpleSetting<CStrW> m_Font;
      63             :     CGUISimpleSetting<CGUISpriteInstance> m_Sprite;
      64             :     CGUISimpleSetting<i32> m_Delay;
      65             :     CGUISimpleSetting<CGUIColor> m_TextColor;
      66             :     CGUISimpleSetting<float> m_MaxWidth;
      67             :     CGUISimpleSetting<CVector2D> m_Offset;
      68             :     CGUISimpleSetting<EVAlign> m_Anchor;
      69             :     CGUISimpleSetting<bool> m_Independent;
      70             :     CGUISimpleSetting<CVector2D> m_MousePos;
      71             :     CGUISimpleSetting<CStr> m_UseObject;
      72             :     CGUISimpleSetting<bool> m_HideObject;
      73             : };
      74             : 
      75             : #endif // INCLUDED_CTOOLTIP