WhisperTab Class Reference

#include <whispertab.h>

Inheritance diagram for WhisperTab:

List of all members.

---

Detailed Description

A tab for whispers from a single player.

Definition at line 32 of file whispertab.h.

Public Member Functions
const std::string &	getNick () const
void	showHelp ()
	Add any extra help text to the output.
bool	handleCommand (const std::string &type, const std::string &args)
	Handle special commands.
Protected Member Functions
	WhisperTab (const std::string &nick)
	Constructor.
	~WhisperTab ()
void	handleInput (const std::string &msg)
void	handleCommand (const std::string &msg)
Private Attributes
std::string	mNick
Friends
class	ChatWindow

---

Constructor & Destructor Documentation

WhisperTab::WhisperTab

(

const std::string &

nick

)

[protected]

Constructor.

Parameters:

nick

the name of the player this tab is whispering to

Definition at line 34 of file whispertab.cpp.

WhisperTab::~WhisperTab

(

)

[protected]

Definition at line 41 of file whispertab.cpp.

---

Member Function Documentation

const std::string& WhisperTab::getNick

(

)

const [inline]

Definition at line 35 of file whispertab.h.

void WhisperTab::showHelp

(

)

[virtual]

Add any extra help text to the output.

Allows tabs to define help for commands defined by the tab itself.

Reimplemented from ChatTab.

Definition at line 67 of file whispertab.cpp.

bool WhisperTab::handleCommand	(	const std::string &	type,
		const std::string &	args
	)			[virtual]

Handle special commands.

Allows a tab to handle commands it defines itself.

Returns:

true if the command was handled false if the command was not handled

Reimplemented from ChatTab.

Definition at line 72 of file whispertab.cpp.

void WhisperTab::handleInput

(

const std::string &

msg

)

[protected, virtual]

Reimplemented from ChatTab.

Definition at line 46 of file whispertab.cpp.

void WhisperTab::handleCommand

(

const std::string &

msg

)

[protected, virtual]

Reimplemented from ChatTab.

Definition at line 59 of file whispertab.cpp.

---

Friends And Related Function Documentation

friend class ChatWindow [friend]

Reimplemented from ChatTab.

Definition at line 43 of file whispertab.h.

---

Member Data Documentation

std::string WhisperTab::mNick [private]

Definition at line 59 of file whispertab.h.

---

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

• tmw/src/gui/widgets/whispertab.h
• tmw/src/gui/widgets/whispertab.cpp