Dynamic tooltips. More...

#include <CTooltip.h>

Inheritance diagram for CTooltip:

Collaboration diagram for CTooltip:

[legend]

Public Member Functions
	CTooltip ()

virtual	~CTooltip ()

Public Member Functions inherited from IGUITextOwner
	IGUITextOwner ()

virtual	~IGUITextOwner ()

void	AddText (SGUIText *text)
	Adds a text object. More...

virtual void	UpdateCachedSize ()

virtual void	DrawText (size_t index, const CColor &color, const CPos &pos, float z, const CRect &clipping=CRect())
	Draws the Text. More...

virtual bool	MouseOverIcon ()
	Test if mouse position is over an icon. More...

Public Member Functions inherited from IGUIObject
	IGUIObject ()

virtual	~IGUIObject ()

virtual bool	MouseOver ()
	Checks if mouse is hovering this object. More...

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

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

CStr	GetPresentableName () const

void	AddToPointersMap (map_pObjects &ObjectMap)
	Adds object and its children to the map, it's name being the first part, and the second being itself. More...

void	AddChild (IGUIObject *pChild)
	Notice nothing will be returned or thrown if the child hasn't been inputted into the GUI yet. More...

vector_pObjects::iterator	begin ()

vector_pObjects::iterator	end ()

bool	SettingExists (const CStr &Setting) const
	Checks if settings exists, only available for derived classes that has this set up, that's why the base class just returns false. More...

PSRETURN	SetSetting (const CStr &Setting, const CStrW &Value, const bool &SkipMessage=false)
	Set a setting by string, regardless of what type it is. More...

PSRETURN	GetSettingType (const CStr &Setting, EGUISettingType &Type) const
	Retrieves the type of a named setting. More...

void	RegisterScriptHandler (const CStr &Action, 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...

CGUI *	GetGUI ()

const CGUI *	GetGUI () const

void	SetFocus ()
	Take focus! More...

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

virtual void	HandleMessage (SGUIMessage &Message)

virtual void	Draw ()
	Draws the object. More...

Protected Member Functions inherited from IGUITextOwner
void	CalculateTextPosition (CRect &ObjSize, CPos &TextPos, SGUIText &Text)
	Calculate the position for the text, based on the alignment. More...

Protected Member Functions inherited from IGUIObject
void	AddSetting (const EGUISettingType &Type, const CStr &Name)
	Add a setting to m_Settings. More...

virtual void	Destroy ()
	Calls Destroy on all children, and deallocates all memory. More...

virtual InReaction	ManuallyHandleEvent (const SDL_Event_ *ev)
	Some objects need to handle the SDL_Event_ manually. More...

void	LoadStyle (CGUI &GUIinstance, const CStr &StyleName)
	Loads a style. More...

void	LoadStyle (const SGUIStyle &Style)
	Loads a style. More...

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

void	SetGUI (CGUI *const &pGUI)

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

virtual void	ResetStates ()
	Reset internal state 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 NULL, so that the top-node's children are seemingly parentless. More...

CPos	GetMousePos () const
	Get Mouse from CGUI. More...

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

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

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

void	ScriptEvent (const CStr &Action, JS::HandleValue Argument)
	Execute the script for a particular action. More...

void	SetScriptHandler (const CStr &Action, JS::HandleObject Function)

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

Additional Inherited Members
Public Attributes inherited from IGUIObject
std::map< CStr, SGUISetting >	m_Settings
	Settings pool, all an object's settings are located here If a derived object has got more settings that the base settings, it's because they have a new version of the function SetupSettings(). More...

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< SGUIText * >	m_GeneratedTexts
	Texts that are generated and ready to be rendered. More...

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

vector_pObjects	m_Children

IGUIObject *	m_pParent

double	m_LastClickTime [6]

bool	m_MouseHovering
	This is an array of true or false, each element is associated with a string representing a setting. More...

Detailed Description

Dynamic tooltips.

Similar to CText.

Constructor & Destructor Documentation

CTooltip::CTooltip ( )

CTooltip::~CTooltip ( )

virtual

Member Function Documentation

void CTooltip::Draw ( )

protectedvirtual

Draws the object.

Exceptions

PSERROR if any. But this will mostlikely be very rare since if an object is drawn unsuccessfully it'll probably only output in the Error log, and not disrupt the whole GUI drawing.

Implements IGUIObject.

void CTooltip::HandleMessage ( SGUIMessage & Message )

protectedvirtual

See also: IGUIObject::HandleMessage()

Reimplemented from IGUITextOwner.

void CTooltip::SetupText ( )

protectedvirtual

Setup texts.

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

Implements IGUITextOwner.

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

/var/svn/checkout/source/gui/CTooltip.h
/var/svn/checkout/source/gui/CTooltip.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation