ChannelTab Class Reference

A tab for a chat channel. More...

#include <channeltab.h>

Inheritance diagram for ChannelTab:

Public Member Functions
Channel *	getChannel () const
void	showHelp () override
	Add any extra help text to the output.
bool	handleCommand (const std::string &type, const std::string &args) override
	Handle special commands.
Public Member Functions inherited from ChatTab
	ChatTab (const std::string &name)
	~ChatTab () override
void	chatLog (std::string line, Own own=BY_SERVER, bool ignoreRecord=false)
	Adds a line of text to our message list.
void	chatLog (const std::string &nick, const std::string &msg)
	Adds the text to the message list.
void	chatInput (const std::string &msg)
	Determines whether the message is a command or message, then sends the given message to the game server to be said, or to the command handler.
void	scroll (int amount)
	Scrolls the chat window.
void	clearText ()
	Clears the text from the tab.
void	getAutoCompleteList (std::vector< std::string > &names) const override
virtual void	saveToLogFile (std::string &msg)
void	event (Event::Channel channel, const Event &event) override
Public Member Functions inherited from Tab
	Tab ()
void	setCaption (const std::string &caption)
	Sets the caption of the tab.
void	draw (gcn::Graphics *graphics) override
	Draw the tab.
void	drawFrame (gcn::Graphics *graphics) override
	Draw the tab frame.
void	setTabColor (const gcn::Color *color)
	Set the normal color fo the tab's text.
void	setFlash (bool flash)
	Set tab flashing state.
Public Member Functions inherited from AutoCompleteLister
virtual	~AutoCompleteLister ()=default
Public Member Functions inherited from EventListener
virtual	~EventListener ()
void	listen (Event::Channel channel)
void	ignore (Event::Channel channel)

Protected Member Functions
	ChannelTab (Channel *channel)
	~ChannelTab () override
void	handleInput (const std::string &msg) override
Protected Member Functions inherited from ChatTab
void	setCurrent () override
virtual void	handleCommand (const std::string &msg)
virtual bool	checkNotify (Own own) const
	Returns whether a notify sound may be played for the given type of message.
void	updateTextFormat (int alpha)
	Adapts the text format to the current gui opacity, for better readability.

Private Attributes
Channel *	mChannel

Friends
class	Channel

Additional Inherited Members
Protected Attributes inherited from ChatTab
ScrollArea *	mScrollArea
BrowserBox *	mTextOutput

Detailed Description

A tab for a chat channel.

Definition at line 31 of file channeltab.h.

Constructor & Destructor Documentation

ChannelTab()

ChannelTab::ChannelTab ( Channel *  channel )

protected

Definition at line 31 of file channeltab.cpp.

~ChannelTab()

ChannelTab::~ChannelTab ( )

overrideprotected

Definition at line 37 of file channeltab.cpp.

Member Function Documentation

getChannel()

Channel * ChannelTab::getChannel ( ) const

inline

Definition at line 34 of file channeltab.h.

handleCommand()

bool ChannelTab::handleCommand ( const std::string &  type, const std::string &  args  )

overridevirtual

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 55 of file channeltab.cpp.

handleInput()

void ChannelTab::handleInput ( const std::string &  msg )

overrideprotectedvirtual

Reimplemented from ChatTab.

Definition at line 41 of file channeltab.cpp.

showHelp()

void ChannelTab::showHelp ( )

overridevirtual

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 46 of file channeltab.cpp.

Friends And Related Symbol Documentation

Channel

friend class Channel

friend

Definition at line 42 of file channeltab.h.

Member Data Documentation

mChannel

Channel* ChannelTab::mChannel

private

Definition at line 51 of file channeltab.h.

---

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

• src/gui/widgets/channeltab.h
• src/gui/widgets/channeltab.cpp