ToolTip Class Reference

#include <ToolTip.h>

Inheritance diagram for ToolTip:

List of all members.

Public Types
enum	ToolTipType {   ToolTipNone = 0, ToolTipHelp = 1, ToolTipInfo = 2,   ToolTipAlignLeft = 4, ToolTipAlignBottom = 8 }
Public Member Functions
	ToolTip (unsigned int type=ToolTipNone, const LangString &title=LangString(), const LangString &text=LangString())
virtual	~ToolTip ()
void	setText (unsigned int type, const LangString &title, const LangString &text)
virtual void	populate ()
void	setHandler (ToolTipI *handler)
unsigned int	getId ()
LangString &	getText ()
LangString &	getTitle ()
unsigned int	getType ()
Protected Attributes
unsigned int	type_
ToolTipI *	handler_
unsigned int	id_
LangString	text_
LangString	title_
Static Protected Attributes
static unsigned int	nextId_ = 0
Friends
class	GLWToolTip

---

Detailed Description

Definition at line 35 of file ToolTip.h.

---

Member Enumeration Documentation

enum ToolTip::ToolTipType

Enumerator:

ToolTipNone
ToolTipHelp
ToolTipInfo
ToolTipAlignLeft
ToolTipAlignBottom

Definition at line 38 of file ToolTip.h.

---

Constructor & Destructor Documentation

ToolTip::ToolTip	(	unsigned int	type = ToolTipNone,
		const LangString &	title = LangString(),
		const LangString &	text = LangString()
	)

Definition at line 30 of file ToolTip.cpp.

References setText().

ToolTip::~ToolTip

(

)

[virtual]

Definition at line 36 of file ToolTip.cpp.

---

Member Function Documentation

void ToolTip::setText	(	unsigned int	type,
		const LangString &	title,
		const LangString &	text
	)

Definition at line 45 of file ToolTip.cpp.

References text_, title_, and type_.

Referenced by GLWToolTip::addToolTip(), GLWTankViewer::draw(), GLWChannelViewTextRenderer::drawCharacter(), NetworkSelectDialog::drawColumnGames(), NetworkSelectDialog::drawIcon(), TargetCamera::getCameraToolTips(), TankAI::getToolTip(), GLWWindow::initFromXML(), Accessory::parseXML(), PlayerDialog::PlayerDialog(), ToolTipResource::populate(), WindDialogToolTip::populate(), TargetTip::populate(), TankTip::populate(), TankElevationTip::populate(), TankRotationTip::populate(), TankPowerTip::populate(), TankWeaponTip::populate(), TankAutoDefenseTip::populate(), TankParachutesTip::populate(), TankHealthTip::populate(), TankRankTip::populate(), TankShieldTip::populate(), TankBatteryTip::populate(), TankFuelTip::populate(), GLMenuEntry::populateCalled(), and ToolTip().

void ToolTip::populate

(

)

[virtual]

Reimplemented in TankFuelTip, TankBatteryTip, TankShieldTip, TankHealthTip, TankRankTip, TankParachutesTip, TankAutoDefenseTip, TankWeaponTip, TankPowerTip, TankRotationTip, TankElevationTip, TankTip, TargetTip, WindDialogToolTip, and ToolTipResource.

Definition at line 40 of file ToolTip.cpp.

References handler_, id_, and ToolTipI::populateCalled().

Referenced by GLWToolTip::draw().

void ToolTip::setHandler

(

ToolTipI *

handler

)

[inline]

Definition at line 61 of file ToolTip.h.

References handler_.

Referenced by GLMenuEntry::GLMenuEntry().

unsigned int ToolTip::getId

(

)

[inline]

Definition at line 63 of file ToolTip.h.

References id_.

LangString& ToolTip::getText

(

)

[inline]

Definition at line 64 of file ToolTip.h.

References text_.

Referenced by ToolTipResource::populate(), and GLWToolTip::setupTip().

LangString& ToolTip::getTitle

(

)

[inline]

Definition at line 65 of file ToolTip.h.

References title_.

Referenced by GLWToolTip::setupTip().

unsigned int ToolTip::getType

(

)

[inline]

Definition at line 66 of file ToolTip.h.

References type_.

Referenced by GLWToolTip::addToolTip(), GLWToolTip::draw(), and ToolTipResource::populate().

---

Friends And Related Function Documentation

friend class GLWToolTip [friend]

Definition at line 47 of file ToolTip.h.

---

Member Data Documentation

unsigned int ToolTip::type_ [protected]

Definition at line 69 of file ToolTip.h.

Referenced by getType(), and setText().

ToolTipI* ToolTip::handler_ [protected]

Definition at line 70 of file ToolTip.h.

Referenced by populate(), and setHandler().

unsigned int ToolTip::id_ [protected]

Definition at line 71 of file ToolTip.h.

Referenced by getId(), and populate().

unsigned int ToolTip::nextId_ = 0 [static, protected]

Definition at line 72 of file ToolTip.h.

LangString ToolTip::text_ [protected]

Definition at line 73 of file ToolTip.h.

Referenced by getText(), and setText().

LangString ToolTip::title_ [protected]

Definition at line 74 of file ToolTip.h.

Referenced by getTitle(), and setText().

---

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

• src/common/common/ToolTip.h
• src/common/common/ToolTip.cpp

---