Dynamic tooltips. More...

#include <CTooltip.h>

Inheritance diagram for CTooltip:

Collaboration diagram for CTooltip:

[legend]

Public Member Functions
	CTooltip (CGUI &pGUI)

virtual	~CTooltip ()

const CStr &	GetUsedObject () const

i32	GetTooltipDelay () const

bool	ShouldHideObject () const

void	SetMousePos (const CVector2D &vec)

Public Member Functions inherited from IGUIObject
	NONCOPYABLE (IGUIObject)

	IGUIObject (CGUI &pGUI)

virtual	~IGUIObject ()

virtual bool	IsMouseOver () const
	This function checks if the mouse is hovering the rectangle that the base setting "size" makes. More...

virtual bool	IsMouseHovering () const
	This function returns true if the mouse is hovering over this GUI object and if this GUI object is the topmost object in that screen location. More...

const CStr &	GetName () const
	Get object name, name is unique. More...

void	SetName (const CStr &Name)
	Get object name. More...

CStr	GetPresentableName () const

const std::vector< IGUIObject * > &	GetChildren () const
	Return all child objects of the current object. More...

void	RegisterSetting (const CStr &Name, IGUISetting *setting)
	Registers the given setting with the GUI object. More...

void	ReregisterSetting (const CStr &Name, IGUISetting *setting)

bool	SettingExists (const CStr &Setting) const
	Returns whether there is a setting with the given name registered. More...

bool	SetSettingFromString (const CStr &Setting, const CStrW &Value, const bool SendMessage)
	Set a setting by string, regardless of what type it is. More...

bool	IsEnabled () const
	Returns whether this object is set to be hidden or ghost. More...

bool	IsHidden () const
	Returns whether this is object is set to be hidden. More...

void	SetHidden (bool hidden)

bool	IsHiddenOrGhost () const
	Returns whether this object is set to be hidden or ghost. More...

void	PlaySound (const CStrW &soundPath) const
	Retrieves the configured sound filename from the given setting name and plays that once. More...

InReaction	SendEvent (EGUIMessageType type, const CStr &eventName)
	Send event to this GUI object (HandleMessage and ScriptEvent) More...

InReaction	SendMouseEvent (EGUIMessageType type, const CStr &eventName)
	Same as SendEvent, but passes mouse coordinates and button state as an argument. More...

CRect	GetComputedSize ()
	Updates and returns the size of the object. More...

virtual const CStrW &	GetTooltipText () const

virtual const CStr &	GetTooltipStyle () const

virtual void	ResetStates ()
	Reset internal state of this object. More...

void	RegisterScriptHandler (const CStr &eventName, const CStr &Code, CGUI &pGUI)
	Set the script handler for a particular object-specific action. More...

JSObject *	GetJSObject ()
	Retrieves the JSObject representing this GUI object. More...

virtual void	Tick ()
	Called on every GUI tick unless the object or one of its parent is hidden/ghost. More...

template<typename... Args>
void	RecurseObject (bool(IGUIObject::isRestricted)() const, void(IGUIObject::callbackFunction)(Args... args), Args &&... args)
	Calls an IGUIObject member function recursively on this object and its children. More...

CGUI &	GetGUI ()

const CGUI &	GetGUI () const

void	SetFocus ()
	Take focus! More...

void	ReleaseFocus ()
	Release focus. More...

Public Member Functions inherited from IGUITextOwner
	IGUITextOwner (IGUIObject &pObject)

virtual	~IGUITextOwner ()

CGUIText &	AddText ()
	Adds a text object. More...

CGUIText &	AddText (const CGUIString &Text, const CStrW &Font, const float &Width, const float &BufferZone)
	Adds a text generated by the given arguments. More...

virtual void	HandleMessage (SGUIMessage &Message)

virtual void	UpdateCachedSize ()

virtual void	DrawText (CCanvas2D &canvas, size_t index, const CGUIColor &color, const CVector2D &pos, const CRect &clipping=CRect())
	Draws the Text. More...

Protected Member Functions
void	SetupText ()
	Setup texts. More...

void	UpdateCachedSize ()

virtual void	HandleMessage (SGUIMessage &Message)

virtual void	Draw (CCanvas2D &canvas)
	Draws the object. More...

virtual float	GetBufferedZ () const
	Returns not the Z value, but the actual buffered Z value, i.e. More...

Protected Member Functions inherited from IGUIObject
virtual InReaction	PreemptEvent (const SDL_Event_ *ev)
	Some objects need to be able to pre-emptively process SDL_Event_. More...

virtual InReaction	ManuallyHandleKeys (const SDL_Event_ *ev)
	Some objects need to handle the text-related SDL_Event_ manually. More...

bool	ApplyStyle (const CStr &StyleName)
	Applies the given style to the object. More...

void	RegisterChild (IGUIObject *child)
	Add an object to the hierarchy. More...

void	UnregisterChild (IGUIObject *child)
	Remove an object from the hierarchy. More...

void	SetParent (IGUIObject *pParent)
	Set parent of this object. More...

bool	IsFocused () const
	Check if object is focused. More...

IGUIObject *	GetParent () const
	NOTE! This will not just return m_pParent, when that is need use it! There is one exception to it, when the parent is the top-node (the object that isn't a real object), this will return nullptr, so that the top-node's children are seemingly parentless. More...

virtual bool	HandleAdditionalChildren (const XMBData &file, const XMBElement &child)
	Handle additional children to the <object>-tag. More...

virtual void	AdditionalChildrenHandled ()
	Allow the GUI object to process after all child items were handled. More...

void	ScriptEvent (const CStr &eventName)
	Execute the script for a particular action. More...

bool	ScriptEventWithReturn (const CStr &eventName)
	Execute the script for a particular action. More...

void	ScriptEvent (const CStr &eventName, const JS::HandleValueArray &paramData)
	Execute the script for a particular action. More...

bool	ScriptEventWithReturn (const CStr &eventName, const JS::HandleValueArray &paramData)
	Execute the script for a particular action. More...

void	SetScriptHandler (const CStr &eventName, JS::HandleObject Function)
	Assigns a JS function to the event name. More...

void	UnsetScriptHandler (const CStr &eventName)
	Deletes an event handler assigned to the given name, if such a handler exists. More...

void	UpdateMouseOver (IGUIObject *const &pMouseOver)
	Inputes the object that is currently hovered, this function updates this object accordingly (i.e. More...

Protected Member Functions inherited from IGUITextOwner
virtual void	SetupText ()=0
	Setup texts. More...

virtual void	UpdateText ()
	Regenerate the text in case it is invalid. More...

void	CalculateTextPosition (CRect &ObjSize, CVector2D &TextPos, CGUIText &Text)
	Calculate the position for the text, based on the alignment. More...

Protected Attributes
CGUISimpleSetting< float >	m_BufferZone

CGUISimpleSetting< CGUIString >	m_Caption

CGUISimpleSetting< CStrW >	m_Font

CGUISimpleSetting< CGUISpriteInstance >	m_Sprite

CGUISimpleSetting< i32 >	m_Delay

CGUISimpleSetting< CGUIColor >	m_TextColor

CGUISimpleSetting< float >	m_MaxWidth

CGUISimpleSetting< CVector2D >	m_Offset

CGUISimpleSetting< EVAlign >	m_Anchor

CGUISimpleSetting< bool >	m_Independent

CGUISimpleSetting< CVector2D >	m_MousePos

CGUISimpleSetting< CStr >	m_UseObject

CGUISimpleSetting< bool >	m_HideObject

Protected Attributes inherited from IGUIObject
CRect	m_CachedActualSize
	Cached size, real size m_Size is actually dependent on resolution and can have different real outcomes, this is the real outcome cached to avoid slow calculations in real time. More...

CStr	m_Name

std::vector< IGUIObject * >	m_Children

IGUIObject *	m_pParent

double	m_LastClickTime [6]

bool	m_MouseHovering
	This variable is true if the mouse is hovering this object and this object is the topmost object shown in this location. More...

std::map< CStr, IGUISetting * >	m_Settings
	Settings pool, all an object's settings are located here. More...

CGUI &	m_pGUI

std::map< CStr, JS::Heap< JSObject * > >	m_ScriptHandlers

std::unique_ptr< IGUIProxyObject >	m_JSObject

CGUISimpleSetting< bool >	m_Enabled

CGUISimpleSetting< bool >	m_Hidden

CGUISimpleSetting< CGUISize >	m_Size

CGUISimpleSetting< CStr >	m_Style

CGUIHotkey	m_Hotkey

CGUISimpleSetting< float >	m_Z

CGUISimpleSetting< bool >	m_Absolute

CGUISimpleSetting< bool >	m_Ghost

CGUISimpleSetting< float >	m_AspectRatio

CGUISimpleSetting< CStrW >	m_Tooltip

CGUISimpleSetting< CStr >	m_TooltipStyle

Protected Attributes inherited from IGUITextOwner
bool	m_GeneratedTextsValid
	Whether the cached text is currently valid (if not then SetupText will be called by Draw) More...

std::vector< CGUIText >	m_GeneratedTexts
	Texts that are generated and ready to be rendered. More...

CGUISimpleSetting< EAlign >	m_TextAlign

CGUISimpleSetting< EVAlign >	m_TextVAlign

Additional Inherited Members
Static Protected Attributes inherited from IGUIObject
static const CStr	EventNameMouseEnter = "MouseEnter"

static const CStr	EventNameMouseMove = "MouseMove"

static const CStr	EventNameMouseLeave = "MouseLeave"

Detailed Description

Dynamic tooltips.

Similar to CText.

Constructor & Destructor Documentation

◆ CTooltip()

CTooltip::CTooltip ( CGUI & pGUI )

◆ ~CTooltip()

CTooltip::~CTooltip ( )

virtual

Member Function Documentation

◆ Draw()

void CTooltip::Draw ( CCanvas2D & canvas )

protectedvirtual

Draws the object.

Implements IGUIObject.

◆ GetBufferedZ()

float CTooltip::GetBufferedZ ( ) const

protectedvirtual

Returns not the Z value, but the actual buffered Z value, i.e.

if it's defined relative, then it will check its parent's Z value and add the relativity.

Returns: Actual Z value on the screen.

Reimplemented from IGUIObject.

◆ GetTooltipDelay()

i32 CTooltip::GetTooltipDelay ( ) const

inline

◆ GetUsedObject()

const CStr & CTooltip::GetUsedObject ( ) const

inline

◆ HandleMessage()

void CTooltip::HandleMessage ( SGUIMessage & Message )

protectedvirtual

See also: IGUIObject::HandleMessage()

Reimplemented from IGUIObject.

◆ SetMousePos()

void CTooltip::SetMousePos ( const CVector2D & vec )

inline

◆ SetupText()

void CTooltip::SetupText ( )

protectedvirtual

Setup texts.

Functions that sets up all texts when changes have been made.

Implements IGUITextOwner.

◆ ShouldHideObject()

bool CTooltip::ShouldHideObject ( ) const

inline

◆ UpdateCachedSize()

void CTooltip::UpdateCachedSize ( )

protectedvirtual

See also: IGUIObject::UpdateCachedSize()

Reimplemented from IGUIObject.

Member Data Documentation

◆ m_Anchor

CGUISimpleSetting<EVAlign> CTooltip::m_Anchor

protected

◆ m_BufferZone

CGUISimpleSetting<float> CTooltip::m_BufferZone

protected

◆ m_Caption

CGUISimpleSetting<CGUIString> CTooltip::m_Caption

protected

◆ m_Delay

CGUISimpleSetting<i32> CTooltip::m_Delay

protected

◆ m_Font

CGUISimpleSetting<CStrW> CTooltip::m_Font

protected

◆ m_HideObject

CGUISimpleSetting<bool> CTooltip::m_HideObject

protected

◆ m_Independent

CGUISimpleSetting<bool> CTooltip::m_Independent

protected

◆ m_MaxWidth

CGUISimpleSetting<float> CTooltip::m_MaxWidth

protected

◆ m_MousePos

CGUISimpleSetting<CVector2D> CTooltip::m_MousePos

protected

◆ m_Offset

CGUISimpleSetting<CVector2D> CTooltip::m_Offset

protected

◆ m_Sprite

CGUISimpleSetting<CGUISpriteInstance> CTooltip::m_Sprite

protected

◆ m_TextColor

CGUISimpleSetting<CGUIColor> CTooltip::m_TextColor

protected

◆ m_UseObject

CGUISimpleSetting<CStr> CTooltip::m_UseObject

protected

The documentation for this class was generated from the following files:

/home/docker/jenkins/workspace/technical-docs/source/gui/ObjectTypes/CTooltip.h
/home/docker/jenkins/workspace/technical-docs/source/gui/ObjectTypes/CTooltip.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CTooltip()

◆ ~CTooltip()

Member Function Documentation

◆ Draw()

◆ GetBufferedZ()

◆ GetTooltipDelay()

◆ GetUsedObject()

◆ HandleMessage()

◆ SetMousePos()

◆ SetupText()

◆ ShouldHideObject()

◆ UpdateCachedSize()

Member Data Documentation

◆ m_Anchor

◆ m_BufferZone

◆ m_Caption

◆ m_Delay

◆ m_Font

◆ m_HideObject

◆ m_Independent

◆ m_MaxWidth

◆ m_MousePos

◆ m_Offset

◆ m_Sprite

◆ m_TextColor

◆ m_UseObject