#include <whispertab.h>

Inheritance diagram for WhisperTab:

Public Member Functions
const std::string &	getNick () const

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

void	setWhisperTabColors ()

void	setWhisperTabOfflineColors ()

Public Member Functions inherited from ChatTab
	ChatTab (const Widget2 *const widget, const std::string &name, const std::string &channel, const std::string &logName, const ChatTabTypeT &type)

	~ChatTab ()

void	chatLog (std::string line, ChatMsgTypeT own, const IgnoreRecord ignoreRecord, const TryRemoveColors tryRemoveColors)

void	chatLog (const std::string &nick, std::string msg)

void	chatInput (const std::string &msg)

void	scroll (const int amount)

void	clearText ()

virtual bool	handleCommands (const std::string &type, const std::string &args)

ChatTabTypeT	getType () const

void	saveToLogFile (const std::string &msg) const

const std::list< std::string > &	getRows () const

bool	hasRows () const

void	loadFromLogFile (const std::string &name)

bool	getAllowHighlight () const

void	setAllowHighlight (const bool n)

bool	getRemoveNames () const

void	setRemoveNames (const bool n)

bool	getNoAway () const

void	setNoAway (const bool n)

void	addNewRow (std::string &line)

void	showOnline (const std::string &nick, const Online online)

virtual void	playNewMessageSound () const

const std::string &	getChannelName () const

Public Member Functions inherited from Tab
	Tab (const Widget2 *const widget)

	~Tab ()

void	updateAlpha ()

void	draw (Graphics *const graphics)

void	safeDraw (Graphics *const graphics)

void	setTabColor (const Color const color1, const Color const color2)

void	setHighlightedTabColor (const Color const color1, const Color const color2)

void	setSelectedTabColor (const Color const color1, const Color const color2)

void	setFlashTabColor (const Color const color1, const Color const color2)

void	setPlayerFlashTabColor (const Color const color1, const Color const color2)

void	setFlash (const int flash)

int	getFlash () const

void	widgetResized (const Event &event)

void	widgetMoved (const Event &event)

void	setLabelFont (Font *const font)

Label *	getLabel () const

void	adjustSize ()

void	setTabbedArea (TabbedArea *tabbedArea)

TabbedArea *	getTabbedArea () const

void	setCaption (const std::string &caption)

const std::string &	getCaption () const

void	mouseEntered (MouseEvent &event)

void	mouseExited (MouseEvent &event)

void	setImage (Image *const image)

Public Member Functions inherited from BasicContainer
	BasicContainer (const Widget2 *const widget)

	~BasicContainer ()

void	showWidgetPart (Widget *const widget, const Rect &area)

void	moveToTop (Widget *const widget)

void	moveToBottom (Widget *const widget)

Rect	getChildrenArea ()

void	focusNext ()

void	focusPrevious ()

void	logic ()

void	setFocusHandler (FocusHandler *const focusHandler)

void	setInternalFocusHandler (FocusHandler *const focusHandler)

Widget *	getWidgetAt (int x, int y)

void	death (const Event &event)

Widget *	findFirstWidget (const std::set< Widget * > &list)

void	add (Widget *const widget)

virtual void	remove (Widget *const widget)

virtual void	clear ()

Public Member Functions inherited from Widget
	Widget (const Widget2 *const widget)

	~Widget ()

virtual void	drawFrame (Graphics *graphics)

virtual void	safeDrawFrame (Graphics *graphics)

void	setFrameSize (const unsigned int frameSize)

unsigned int	getFrameSize () const

Widget *	getParent () const

void	setWidth (const int width)

int	getWidth () const

void	setHeight (const int height)

int	getHeight () const

void	setSize (const int width, const int height)

void	setX (const int x)

int	getX () const

void	setY (const int y)

int	getY () const

void	setPosition (const int x, const int y)

void	setDimension (const Rect &dimension)

const Rect &	getDimension () const

void	setFocusable (const bool focusable)

bool	isFocusable () const

virtual bool	isFocused () const

void	setEnabled (const bool enabled)

bool	isEnabled () const

void	setVisible (Visible visible)

bool	isVisible () const

void	setBaseColor (const Color &color)

const Color &	getBaseColor () const

void	setForegroundColor (const Color &color)

const Color &	getForegroundColor () const

void	setBackgroundColor (const Color &color)

const Color &	getBackgroundColor () const

virtual void	requestFocus ()

virtual void	requestMoveToTop ()

virtual void	requestMoveToBottom ()

FocusHandler *	getFocusHandler ()

void	addActionListener (ActionListener *const actionListener)

void	removeActionListener (ActionListener *const actionListener)

void	addDeathListener (WidgetDeathListener *const deathListener)

void	removeDeathListener (WidgetDeathListener *const deathListener)

void	addMouseListener (MouseListener *const mouseListener)

void	removeMouseListener (MouseListener *const mouseListener)

void	addKeyListener (KeyListener *const keyListener)

void	removeKeyListener (KeyListener *const keyListener)

void	addFocusListener (FocusListener *const focusListener)

void	removeFocusListener (FocusListener *const focusListener)

void	addWidgetListener (WidgetListener *const widgetListener)

void	removeWidgetListener (WidgetListener *const widgetListener)

void	setActionEventId (const std::string &actionEventId)

const std::string &	getActionEventId () const

virtual void	getAbsolutePosition (int &x, int &y) const

virtual void	setParent (Widget *parent)

Font *	getFont () const

void	setFont (Font *const font)

virtual void	fontChanged ()

bool	isTabInEnabled () const

void	setTabInEnabled (const bool enabled)

bool	isTabOutEnabled () const

void	setTabOutEnabled (const bool enabled)

void	requestModalFocus ()

virtual void	requestModalMouseInputFocus ()

virtual void	releaseModalFocus ()

virtual void	releaseModalMouseInputFocus ()

virtual bool	isModalFocused () const

virtual bool	isModalMouseInputFocused () const

const std::list< MouseListener * > &	getMouseListeners () const A_CONST

const std::list< KeyListener * > &	getKeyListeners () const A_CONST

const std::list< FocusListener * > &	getFocusListeners () const A_CONST

virtual FocusHandler *	getInternalFocusHandler ()

void	setInternalFocusHandler (FocusHandler *const internalFocusHandler)

void	setId (const std::string &id)

const std::string &	getId () const

virtual void	showPart (const Rect &rectangle)

bool	isAllowLogic () const

void	setMouseConsume (const bool b)

bool	isMouseConsume () const

void	setRedraw (const bool b)

virtual bool	isSelectable () const

void	setSelectable (const bool selectable)

void	windowResized ()

virtual void	postInit ()

Public Member Functions inherited from Widget2
virtual	~Widget2 ()

const Color &	getThemeColor (const ThemeColorIdT type, const unsigned int alpha) const A_INLINE

const Color &	getThemeCharColor (const signed char c, bool &valid) const A_INLINE

virtual void	setWidget2 (const Widget2 *const widget)

void	setPalette (int palette)

void	checkPalette ()

void	setForegroundColor2 (const Color &color)

Widget *	getWindow () const

virtual void	setWindow (Widget *const window)

Public Member Functions inherited from WidgetDeathListener
virtual	~WidgetDeathListener ()

Public Member Functions inherited from MouseListener
virtual	~MouseListener ()

virtual void	mousePressed (MouseEvent &event)

virtual void	mouseReleased (MouseEvent &event)

virtual void	mouseClicked (MouseEvent &event)

virtual void	mouseWheelMovedUp (MouseEvent &event)

virtual void	mouseWheelMovedDown (MouseEvent &event)

virtual void	mouseMoved (MouseEvent &event)

virtual void	mouseDragged (MouseEvent &event)

Public Member Functions inherited from WidgetListener
virtual	~WidgetListener ()

virtual void	widgetHidden (const Event &event)

virtual void	widgetShown (const Event &event)

Protected Member Functions
void	getAutoCompleteList (StringVect &names) const

void	getAutoCompleteCommands (StringVect &commands) const

	WhisperTab (const Widget2 *const widget, const std::string &caption, const std::string &nick)

	~WhisperTab ()

void	handleInput (const std::string &msg)

void	handleCommandStr (const std::string &msg)

Protected Member Functions inherited from ChatTab
void	setCurrent ()

virtual void	handleHelp (const std::string &msg)

void	addRow (std::string &line)

Protected Member Functions inherited from BasicContainer
virtual void	drawChildren (Graphics *const graphics)

virtual void	safeDrawChildren (Graphics *const graphics)

virtual void	logicChildren ()

Protected Member Functions inherited from Widget
void	distributeActionEvent ()

void	distributeResizedEvent ()

void	distributeMovedEvent ()

void	distributeHiddenEvent ()

void	distributeShownEvent ()

Protected Member Functions inherited from Widget2
	Widget2 (const Widget2 *const widget)

Protected Member Functions inherited from WidgetDeathListener
	WidgetDeathListener ()

Protected Member Functions inherited from MouseListener
	MouseListener ()

Protected Member Functions inherited from WidgetListener
	WidgetListener ()

Private Attributes
std::string	mNick

Friends
class	ChatWindow

Additional Inherited Members
Public Types inherited from Tab
enum	{ TAB_STANDARD = 0 , TAB_HIGHLIGHTED = 1 , TAB_SELECTED = 2 , TAB_UNUSED = 3 , TAB_COUNT = 4 }

Static Public Member Functions inherited from Tab
static void	finalCleanup ()

Static Public Member Functions inherited from Widget
static void	setGlobalFont (Font *const font)

static Font *	getGloablFont ()

static void	cleanGlobalFont ()

static bool	widgetExists (const Widget *const widget)

static void	distributeWindowResizeEvent ()

static Widget *	callPostInit (Widget *const widget)

Data Fields inherited from Widget
Visible	mVisible

Protected Types inherited from BasicContainer
typedef std::vector< Widget * >	WidgetList

typedef WidgetList::iterator	WidgetListIterator

typedef WidgetList::const_iterator	WidgetListConstIterator

typedef WidgetList::reverse_iterator	WidgetListReverseIterator

typedef WidgetList::const_reverse_iterator	WidgetListCReverseIterator

Protected Types inherited from Widget
typedef std::list< MouseListener * >	MouseListenerList

typedef MouseListenerList::iterator	MouseListenerIterator

typedef std::list< KeyListener * >	KeyListenerList

typedef KeyListenerList::iterator	KeyListenerIterator

typedef std::list< ActionListener * >	ActionListenerList

typedef ActionListenerList::iterator	ActionListenerIterator

typedef std::list< WidgetDeathListener * >	WidgetDeathListenerList

typedef WidgetDeathListenerList::iterator	WidgetDeathListenerIterator

typedef std::list< FocusListener * >	FocusListenerList

typedef FocusListenerList::iterator	FocusListenerIterator

typedef std::list< WidgetListener * >	WidgetListenerList

typedef WidgetListenerList::iterator	WidgetListenerIterator

Protected Attributes inherited from ChatTab
BrowserBox *	mTextOutput

ScrollArea *	mScrollArea

std::string	mChannelName

std::string	mLogName

ChatTabTypeT	mType

bool	mAllowHightlight

bool	mRemoveNames

bool	mNoAway

bool	mShowOnline

Protected Attributes inherited from Tab
Label *	mLabel

TabbedArea *	mTabbedArea

bool	mHasMouse

Protected Attributes inherited from BasicContainer
WidgetList	mWidgets

WidgetList	mLogicWidgets

Protected Attributes inherited from Widget
MouseListenerList	mMouseListeners

KeyListenerList	mKeyListeners

ActionListenerList	mActionListeners

WidgetDeathListenerList	mDeathListeners

FocusListenerList	mFocusListeners

WidgetListenerList	mWidgetListeners

Color	mForegroundColor

Color	mBackgroundColor

Color	mBaseColor

Rect	mDimension

std::string	mActionEventId

std::string	mId

FocusHandler *	mFocusHandler

FocusHandler *	mInternalFocusHandler

Widget *	mParent

Font *	mCurrentFont

unsigned int	mFrameSize

bool	mFocusable

bool	mTabIn

bool	mTabOut

bool	mEnabled

bool	mAllowLogic

bool	mMouseConsume

bool	mRedraw

bool	mSelectable

Protected Attributes inherited from Widget2
int	mPaletteOffset

Widget *	mWindow

Color	mForegroundColor2

Static Protected Attributes inherited from Widget
static Font *	mGlobalFont = 0

Detailed Description

A tab for whispers from a single player.

Definition at line 32 of file whispertab.h.

Constructor & Destructor Documentation

◆ WhisperTab()

WhisperTab::WhisperTab	(	const Widget2 *const	widget,
		const std::string &	caption,
		const std::string &	nick
	)

protected

Constructor.

Parameters

nick	the name of the player this tab is whispering to

Definition at line 38 of file whispertab.cpp.

                                               :
     ChatTab(widget, caption, nick, nick, ChatTabType::WHISPER),
     mNick(nick)
 {
     setWhisperTabColors();
 }

References setWhisperTabColors().

◆ ~WhisperTab()

WhisperTab::~WhisperTab ( )

protected

Definition at line 47 of file whispertab.cpp.

 {
     if (chatWindow != nullptr)
         chatWindow->removeWhisper(mNick);
 }

References chatWindow, mNick, and ChatWindow::removeWhisper().

Member Function Documentation

◆ getAutoCompleteCommands()

void WhisperTab::getAutoCompleteCommands ( StringVect & commands ) const

protectedvirtual

Reimplemented from ChatTab.

Definition at line 118 of file whispertab.cpp.

 {
     commands.push_back("/close");
 }

◆ getAutoCompleteList()

void WhisperTab::getAutoCompleteList ( StringVect & names ) const

protectedvirtual

Reimplemented from ChatTab.

Definition at line 113 of file whispertab.cpp.

 {
     names.push_back(mNick);
 }

References mNick.

◆ getNick()

const std::string& WhisperTab::getNick ( ) const

inline

Definition at line 37 of file whispertab.h.

38 { return mNick; }

References mNick.

Referenced by Actions::getNick(), ChatWindow::ignoreAllWhispers(), outStringNormal(), PopupMenu::showChatPopup(), and ChatWindow::updateOnline().

◆ handleCommand()

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 93 of file whispertab.cpp.

 {
     if (type == "close")
     {
         if (windowContainer != nullptr)
             windowContainer->scheduleDelete(this);
         else
             delete this;
         if (chatWindow != nullptr)
             chatWindow->defaultTab();
     }
     else
     {
         return false;
     }
  
     return true;
 }

References chatWindow, ChatWindow::defaultTab(), WindowContainer::scheduleDelete(), and windowContainer.

Referenced by ChatWindow::ignoreAllWhispers().

◆ handleCommandStr()

void WhisperTab::handleCommandStr ( const std::string & msg )

protectedvirtual

Reimplemented from ChatTab.

Definition at line 65 of file whispertab.cpp.

 {
     if (msg == "close")
     {
         delete this;
         return;
     }
  
     const size_t pos = msg.find(' ');
     const std::string type(msg, 0, pos);
  
     if (type == "me")
     {
         const std::string args(msg, pos == std::string::npos
             ? msg.size() : pos + 1);
         std::string str = textToMe(args);
         chatHandler->privateMessage(mNick, str);
         if (localPlayer != nullptr)
             chatLog(localPlayer->getName(), str);
         else
             chatLog("?", str);
     }
     else
     {
         ChatTab::handleCommandStr(msg);
     }
 }

References chatHandler, ChatTab::chatLog(), Being::getName(), ChatTab::handleCommandStr(), localPlayer, mNick, Actions::msg(), Net::ChatHandler::privateMessage(), and textToMe().

◆ handleInput()

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

protectedvirtual

Reimplemented from ChatTab.

Definition at line 53 of file whispertab.cpp.

 {
     std::string newMsg;
     newMsg = ChatWindow::doReplace(msg);
     chatHandler->privateMessage(mNick, newMsg);
  
     if (localPlayer != nullptr)
         chatLog(localPlayer->getName(), newMsg);
     else
         chatLog("?", newMsg);
 }

References chatHandler, ChatTab::chatLog(), ChatWindow::doReplace(), Being::getName(), localPlayer, mNick, Actions::msg(), and Net::ChatHandler::privateMessage().

◆ setWhisperTabColors()

void WhisperTab::setWhisperTabColors ( )

Definition at line 123 of file whispertab.cpp.

 {
     setTabColors(ThemeColorId::WHISPER_TAB);
 }

References setTabColors.

Referenced by LocalPlayer::checkNewName(), ChatWindow::updateOnline(), and WhisperTab().

◆ setWhisperTabOfflineColors()

void WhisperTab::setWhisperTabOfflineColors ( )

Definition at line 128 of file whispertab.cpp.

 {
     setTabColors(ThemeColorId::WHISPER_TAB_OFFLINE);
 }

References setTabColors.

Referenced by ChatWindow::updateOnline().

Friends And Related Function Documentation

◆ ChatWindow

friend class ChatWindow

friend

Definition at line 48 of file whispertab.h.

Field Documentation

◆ mNick

std::string WhisperTab::mNick

private

Definition at line 71 of file whispertab.h.

Referenced by getAutoCompleteList(), getNick(), handleCommandStr(), handleInput(), and ~WhisperTab().

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

src/gui/widgets/tabs/chat/whispertab.h (986a3bf)
src/gui/widgets/tabs/chat/whispertab.cpp (986a3bf)

Public Member Functions

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WhisperTab()

◆ ~WhisperTab()

Member Function Documentation

◆ getAutoCompleteCommands()

◆ getAutoCompleteList()

◆ getNick()

◆ handleCommand()

◆ handleCommandStr()

◆ handleInput()

◆ setWhisperTabColors()

◆ setWhisperTabOfflineColors()

Friends And Related Function Documentation

◆ ChatWindow

Field Documentation

◆ mNick