#include <chattab.h>

Inheritance diagram for ChatTab:

Public Member Functions
	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	handleCommand (const std::string &type, const std::string &args)

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	setCurrent ()

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

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

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

virtual void	getAutoCompleteList (StringVect &names) const

virtual void	getAutoCompleteCommands (StringVect &names) const

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 ()

Protected Attributes
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

Friends
class	ChatWindow

class	WhisperWindow

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

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

Detailed Description

A tab for the chat window. This is special to ease chat handling.

Definition at line 62 of file chattab.h.

Constructor & Destructor Documentation

◆ ChatTab()

ChatTab::ChatTab	(	const Widget2 *const	widget,
		const std::string &	name,
		const std::string &	channel,
		const std::string &	logName,
		const ChatTabTypeT &	type
	)

Constructor.

Definition at line 67 of file chattab.cpp.

                                            :
     Tab(widget),
     mTextOutput(new BrowserBox(this, Opaque_true,
        "browserbox.xml")),
     mScrollArea(new ScrollArea(this,
         mTextOutput, Opaque_false, std::string())),
     mChannelName(channel),
     mLogName(logName),
     mType(type),
     mAllowHightlight(true),
     mRemoveNames(false),
     mNoAway(false),
     mShowOnline(false)
 {
     setCaption(name);
  
     mTextOutput->setOpaque(Opaque_false);
     mTextOutput->setMaxRow(config.getIntValue("ChatLogLength"));
     if (chatWindow != nullptr)
         mTextOutput->setLinkHandler(chatWindow->mItemLinkHandler);
     mTextOutput->setAlwaysUpdate(false);
  
     mScrollArea->setScrollPolicy(ScrollArea::SHOW_NEVER,
         ScrollArea::SHOW_ALWAYS);
     mScrollArea->setScrollAmount(0, 1);
  
     if (chatWindow != nullptr)
         chatWindow->addTab(this);
     mTextOutput->updateSize(true);
 }

References ChatWindow::addTab(), chatWindow, config, Configuration::getIntValue(), ChatWindow::mItemLinkHandler, mScrollArea, mTextOutput, Opaque_false, BrowserBox::setAlwaysUpdate(), Tab::setCaption(), BrowserBox::setLinkHandler(), BrowserBox::setMaxRow(), BrowserBox::setOpaque(), ScrollArea::setScrollAmount(), ScrollArea::setScrollPolicy(), ScrollArea::SHOW_ALWAYS, ScrollArea::SHOW_NEVER, and BrowserBox::updateSize().

◆ ~ChatTab()

ChatTab::~ChatTab ( )

Definition at line 102 of file chattab.cpp.

 {
     if (chatWindow != nullptr)
         chatWindow->removeTab(this);
  
     delete2(mTextOutput)
     delete2(mScrollArea)
 }

References chatWindow, delete2, mScrollArea, mTextOutput, and ChatWindow::removeTab().

Member Function Documentation

◆ addNewRow()

void ChatTab::addNewRow ( std::string & line )

Definition at line 526 of file chattab.cpp.

 {
     if (mScrollArea->getVerticalScrollAmount() >=
         mScrollArea->getVerticalMaxScroll())
     {
         addRow(line);
         mScrollArea->setVerticalScrollAmount(
             mScrollArea->getVerticalMaxScroll());
     }
     else
     {
         addRow(line);
     }
     mScrollArea->logic();
 }

References addRow(), ScrollArea::getVerticalMaxScroll(), ScrollArea::getVerticalScrollAmount(), ScrollArea::logic(), mScrollArea, and ScrollArea::setVerticalScrollAmount().

Referenced by ChatWindow::displayAwayLog().

◆ addRow()

void ChatTab::addRow ( std::string & line )

protected

Definition at line 488 of file chattab.cpp.

 {
     if (line.find("[@@http") == std::string::npos)
     {
         size_t idx = 0;
         for (size_t f = 0; f < line.length(); f++)
         {
             if (line.at(f) == ' ')
             {
                 idx = f;
             }
             else if (f - idx > MAX_WORD_SIZE)
             {
                 line.insert(f, " ");
                 idx = f;
             }
         }
     }
     mTextOutput->addRow(line,
         false);
 }

References BrowserBox::addRow(), MAX_WORD_SIZE, and mTextOutput.

Referenced by addNewRow(), chatLog(), and loadFromLogFile().

◆ chatInput()

void ChatTab::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

Parameters

msg	The message text which is to be sent.

Definition at line 382 of file chattab.cpp.

 {
     std::string msg = message;
     trim(msg);
  
     if (msg.empty())
         return;
  
     replaceItemLinks(msg);
     replaceVars(msg);
  
     switch (msg[0])
     {
         case '/':
             handleCommandStr(std::string(msg, 1));
             break;
         case '?':
             if (msg.size() > 1 &&
                 msg[1] != '!' &&
                 msg[1] != '?' &&
                 msg[1] != '.' &&
                 msg[1] != ' ' &&
                 msg[1] != ',')
             {
                 handleHelp(std::string(msg, 1));
             }
             else
             {
                 handleInput(msg);
             }
             break;
         default:
             handleInput(msg);
             break;
     }
 }

References handleCommandStr(), handleHelp(), handleInput(), Actions::msg(), replaceItemLinks(), BrowserBoxTools::replaceVars(), and Catch::trim().

Referenced by ChatWindow::addWhisper(), ChatWindow::chatInput(), ChatWindow::localChatInput(), and Actions::outString().

◆ chatLog() [1/2]

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

Adds the text to the message list

Parameters

msg	The message text which is to be sent.

Definition at line 367 of file chattab.cpp.

 {
     if (localPlayer == nullptr)
         return;
  
     const ChatMsgTypeT byWho = (nick == localPlayer->getName()
         ? ChatMsgType::BY_PLAYER : ChatMsgType::BY_OTHER);
     if (byWho == ChatMsgType::BY_OTHER && config.getBoolValue("removeColors"))
         msg = removeColors(msg);
     chatLog(std::string(nick).append(" : ").append(msg),
         byWho,
         IgnoreRecord_false,
         TryRemoveColors_false);
 }

References ChatMsgType::BY_OTHER, ChatMsgType::BY_PLAYER, chatLog(), config, Configuration::getBoolValue(), Being::getName(), IgnoreRecord_false, localPlayer, Actions::msg(), removeColors(), and TryRemoveColors_false.

◆ chatLog() [2/2]

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

Adds a line of text to our message list. Parameters:

Parameters

line	Text message.
own	Type of message (usually the owner-type).
ignoreRecord	should this not be recorded?
tryRemoveColors	try remove color if configured

Definition at line 111 of file chattab.cpp.

 {
     // Trim whitespace
     trim(line);
  
     if (line.empty())
         return;
  
     if (tryRemoveColors == TryRemoveColors_true &&
         own == ChatMsgType::BY_OTHER &&
         config.getBoolValue("removeColors"))
     {
         line = removeColors(line);
         if (line.empty())
             return;
     }
  
     const unsigned lineLim = config.getIntValue("chatMaxCharLimit");
     if (lineLim > 0 && line.length() > lineLim)
         line = line.substr(0, lineLim);
  
     if (line.empty())
         return;
  
     CHATLOG tmp;
     tmp.own = own;
     tmp.nick.clear();
     tmp.text = line;
  
     const size_t pos = line.find(" : ");
     if (pos != std::string::npos)
     {
         if (line.length() <= pos + 3)
             return;
  
         tmp.nick = line.substr(0, pos);
         tmp.text = line.substr(pos + 3);
     }
     else
     {
         // Fix the owner of welcome message.
         if (line.length() > 7 && line.substr(0, 7) == "Welcome")
             own = ChatMsgType::BY_SERVER;
     }
  
     // *implements actions in a backwards compatible way*
     if ((own == ChatMsgType::BY_PLAYER || own == ChatMsgType::BY_OTHER) &&
         tmp.text.at(0) == '*' &&
         tmp.text.at(tmp.text.length()-1) == '*')
     {
         tmp.text[0] = ' ';
         tmp.text.erase(tmp.text.length() - 1);
         own = ChatMsgType::ACT_IS;
     }
  
     std::string lineColor("##C");
     switch (own)
     {
         case ChatMsgType::BY_GM:
             if (tmp.nick.empty())
             {
                 // TRANSLATORS: chat message
                 tmp.nick = std::string(_("Global announcement:")).append(" ");
                 lineColor = "##G";
             }
             else
             {
                 // TRANSLATORS: chat message
                 tmp.nick = strprintf(_("Global announcement from %s:"),
                                      tmp.nick.c_str()).append(" ");
                 lineColor = "##g";  // Equiv. to BrowserBox::RED
             }
             break;
         case ChatMsgType::BY_PLAYER:
             tmp.nick.append(": ");
             lineColor = "##Y";
             break;
         case ChatMsgType::BY_OTHER:
         case ChatMsgType::BY_UNKNOWN:
             tmp.nick.append(": ");
             lineColor = "##C";
             break;
         case ChatMsgType::BY_SERVER:
             // TRANSLATORS: chat message
             tmp.nick.clear();
             tmp.text = line;
             lineColor = "##S";
             break;
         case ChatMsgType::BY_CHANNEL:
             tmp.nick.clear();
             lineColor = "##2";  // Equiv. to BrowserBox::GREEN
             break;
         case ChatMsgType::ACT_WHISPER:
             // TRANSLATORS: chat message
             tmp.nick = strprintf(_("%s whispers: %s"), tmp.nick.c_str(), "");
             lineColor = "##W";
             break;
         case ChatMsgType::ACT_IS:
             lineColor = "##I";
             break;
         case ChatMsgType::BY_LOGGER:
             tmp.nick.clear();
             tmp.text = line;
             lineColor = "##L";
             break;
         default:
             break;
     }
  
     if (tmp.nick == ": ")
     {
         tmp.nick.clear();
         lineColor = "##S";
     }
  
     // if configured, move magic messages log to debug chat tab
     if (Net::getNetworkType() == ServerType::TMWATHENA
         && (localChatTab != nullptr) && this == localChatTab
         && ((config.getBoolValue("showMagicInDebug")
         && own == ChatMsgType::BY_PLAYER
         && tmp.text.length() > 1
         && tmp.text.at(0) == '#'
         && tmp.text.at(1) != '#')
         || (config.getBoolValue("serverMsgInDebug")
         && (own == ChatMsgType::BY_SERVER
         || tmp.nick.empty()))))
     {
         if (debugChatTab != nullptr)
             debugChatTab->chatLog(line, own, ignoreRecord, tryRemoveColors);
         return;
     }
  
     // Get the current system time
     time_t t;
     time(&t);
  
     if (config.getBoolValue("useLocalTime"))
     {
         const tm *const timeInfo = localtime(&t);
         if (timeInfo != nullptr)
         {
             line = strprintf("%s[%02d:%02d] %s%s", lineColor.c_str(),
                 timeInfo->tm_hour, timeInfo->tm_min, tmp.nick.c_str(),
                 tmp.text.c_str());
         }
         else
         {
             line = strprintf("%s %s%s", lineColor.c_str(),
                 tmp.nick.c_str(), tmp.text.c_str());
         }
     }
     else
     {
         // Format the time string properly
         std::stringstream timeStr;
         timeStr << "[" << ((((t / 60) / 60) % 24 < 10) ? "0" : "")
             << CAST_S32(((t / 60) / 60) % 24)
             << ":" << (((t / 60) % 60 < 10) ? "0" : "")
             << CAST_S32((t / 60) % 60)
             << "] ";
         line = std::string(lineColor).append(timeStr.str()).append(
             tmp.nick).append(tmp.text);
     }
  
     if (config.getBoolValue("enableChatLog"))
         saveToLogFile(line);
  
     mTextOutput->setMaxRow(config.getIntValue("chatMaxLinesLimit"));
  
     // We look if the Vertical Scroll Bar is set at the max before
     // adding a row, otherwise the max will always be a row higher
     // at comparison.
     if (mScrollArea->getVerticalScrollAmount() + 2 >=
         mScrollArea->getVerticalMaxScroll())
     {
         addRow(line);
         mScrollArea->setVerticalScrollAmount(
             mScrollArea->getVerticalMaxScroll());
     }
     else
     {
         addRow(line);
     }
  
     if ((chatWindow != nullptr) && this == localChatTab)
         chatWindow->addToAwayLog(line);
  
     mScrollArea->logic();
     if (own != ChatMsgType::BY_PLAYER)
     {
         if (own == ChatMsgType::BY_SERVER &&
             (getType() == ChatTabType::PARTY ||
             getType() == ChatTabType::CHANNEL ||
             getType() == ChatTabType::GUILD))
         {
             return;
         }
  
         const TabbedArea *const tabArea = getTabbedArea();
         if (tabArea == nullptr)
             return;
  
         const bool notFocused = WindowManager::getIsMinimized() ||
             (!settings.mouseFocused &&
             settings.inputFocused == KeyboardFocus::Unfocused);
  
         if (this != tabArea->getSelectedTab() || notFocused)
         {
             if (getFlash() == 0)
             {
                 if (chatWindow != nullptr &&
                     chatWindow->findHighlight(tmp.text))
                 {
                     setFlash(2);
                     soundManager.playGuiSound(SOUND_HIGHLIGHT);
                 }
                 else
                 {
                     setFlash(1);
                 }
             }
             else if (getFlash() == 2)
             {
                 if (chatWindow != nullptr &&
                     chatWindow->findHighlight(tmp.text))
                 {
                     soundManager.playGuiSound(SOUND_HIGHLIGHT);
                 }
             }
         }
  
         if ((getAllowHighlight() ||
             own == ChatMsgType::BY_GM) &&
             (this != tabArea->getSelectedTab() ||
             notFocused))
         {
             if (own == ChatMsgType::BY_GM)
             {
                 if (chatWindow != nullptr)
                     chatWindow->unHideWindow();
                 soundManager.playGuiSound(SOUND_GLOBAL);
             }
             else if (own != ChatMsgType::BY_SERVER)
             {
                 if (chatWindow != nullptr)
                     chatWindow->unHideWindow();
                 playNewMessageSound();
             }
             WindowManager::newChatMessage();
         }
     }
 }

References _, ChatMsgType::ACT_IS, ChatMsgType::ACT_WHISPER, addRow(), ChatWindow::addToAwayLog(), ChatMsgType::BY_CHANNEL, ChatMsgType::BY_GM, ChatMsgType::BY_LOGGER, ChatMsgType::BY_OTHER, ChatMsgType::BY_PLAYER, ChatMsgType::BY_SERVER, ChatMsgType::BY_UNKNOWN, CAST_S32, ChatTabType::CHANNEL, chatLog(), chatWindow, config, debugChatTab, ChatWindow::findHighlight(), getAllowHighlight(), Configuration::getBoolValue(), Tab::getFlash(), Configuration::getIntValue(), WindowManager::getIsMinimized(), Net::getNetworkType(), TabbedArea::getSelectedTab(), Tab::getTabbedArea(), getType(), ScrollArea::getVerticalMaxScroll(), ScrollArea::getVerticalScrollAmount(), ChatTabType::GUILD, Settings::inputFocused, localChatTab, ScrollArea::logic(), Settings::mouseFocused, mScrollArea, mTextOutput, WindowManager::newChatMessage(), CHATLOG::nick, CHATLOG::own, ChatTabType::PARTY, SoundManager::playGuiSound(), playNewMessageSound(), removeColors(), saveToLogFile(), Tab::setFlash(), BrowserBox::setMaxRow(), settings, ScrollArea::setVerticalScrollAmount(), SOUND_GLOBAL, SOUND_HIGHLIGHT, soundManager, strprintf(), CHATLOG::text, ServerType::TMWATHENA, Catch::trim(), TryRemoveColors_true, KeyboardFocus::Unfocused, and ChatWindow::unHideWindow().

Referenced by SocialGuildTab::action(), SocialPartyTab::action(), SocialWindow::action(), TradeWindow::action(), ChatWindow::addGlobalMessage(), ChatWindow::addWhisper(), Game::adjustPerfomance(), LocalPlayer::afkRespond(), ChatWindow::battleChatLog(), ChatWindow::channelChatLog(), GuildManager::chat(), NotifyManager::chatLog(), chatLog(), TradeWindow::checkItem(), createGuiWindows(), ChatWindow::debugMessage(), StatusEffect::deliverMessage(), ChatWindow::doPresent(), Actions::getNick(), WhisperTab::handleCommandStr(), WhisperTab::handleInput(), NotifyManager::notify(), outStringNormal(), LocalPlayer::pickedUp(), ActorManager::printBeingsToChat(), GuildManager::process(), EAthena::ChatRecv::processChatTalkieBox(), EAthena::ClanRecv::processClanChat(), EAthena::GuildRecv::processGuildBasicInfo(), EAthena::GuildRecv::processGuildMessage(), EAthena::GuildRecv::processGuildNotice(), EAthena::PartyRecv::processPartyMessage(), TmwAthena::PartyRecv::processPartyMessage(), EAthena::ChatRecv::processScriptMessage(), TmwAthena::ChatRecv::processScriptMessage(), EAthena::ChatRecv::processServiceMessageColor(), EAthena::ChatRecv::processWhisperContinue(), TmwAthena::ChatRecv::processWhisperContinue(), ChatWindow::resortChatLog(), Game::saveScreenshot(), SocialWindow::showGuildInvite(), showOnline(), and SocialWindow::showPartyInvite().

◆ clearText()

void ChatTab::clearText ( )

Clears the text from the tab

Definition at line 428 of file chattab.cpp.

 {
     mTextOutput->clearRows();
 }

References BrowserBox::clearRows(), and mTextOutput.

Referenced by ChatWindow::clearTab().

◆ getAllowHighlight()

bool ChatTab::getAllowHighlight ( ) const

inline

Definition at line 158 of file chattab.h.

159 { return mAllowHightlight; }

References mAllowHightlight.

Referenced by chatLog(), ChatWindow::saveTab(), and PopupMenu::showChatPopup().

◆ getAutoCompleteCommands()

virtual void ChatTab::getAutoCompleteCommands ( StringVect & names ) const

inlineprotectedvirtual

Reimplemented in PartyTab, GuildTab, EmulateGuildTab, WhisperTab, and ChannelTab.

Definition at line 202 of file chattab.h.

203 {}

Referenced by ChatWindow::autoComplete().

◆ getAutoCompleteList()

virtual void ChatTab::getAutoCompleteList ( StringVect & names ) const

inlineprotectedvirtual

Reimplemented in WhisperTab, PartyTab, GuildTab, GmTab, and EmulateGuildTab.

Definition at line 199 of file chattab.h.

200 {}

Referenced by ChatWindow::autoComplete().

◆ getChannelName()

const std::string& ChatTab::getChannelName ( ) const

inline

Definition at line 183 of file chattab.h.

184 { return mChannelName; }

References mChannelName.

Referenced by ChatWindow::addSpecialChannelTab(), ChatWindow::postConnection(), ChatWindow::resortChatLog(), and ChatWindow::saveTab().

◆ getNoAway()

bool ChatTab::getNoAway ( ) const

inline

Definition at line 170 of file chattab.h.

171 { return mNoAway; }

References mNoAway.

Referenced by LocalPlayer::afkRespond(), ChatWindow::saveTab(), and PopupMenu::showChatPopup().

◆ getRemoveNames()

bool ChatTab::getRemoveNames ( ) const

inline

Definition at line 164 of file chattab.h.

165 { return mRemoveNames; }

References mRemoveNames.

Referenced by ChatWindow::addWhisper(), ChatWindow::saveTab(), and PopupMenu::showChatPopup().

◆ getRows()

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

inline

Definition at line 150 of file chattab.h.

151 { return mTextOutput->getRows(); }

BrowserBox::getRows

TextRows & getRows()

Definition: browserbox.h:124

References BrowserBox::getRows(), and mTextOutput.

Referenced by ChatWindow::keyPressed().

◆ getType()

ChatTabTypeT ChatTab::getType ( ) const

inline

Returns type of the being.

Definition at line 145 of file chattab.h.

146 { return mType; }

References mType.

Referenced by chatLog(), ChatWindow::closeTab(), Actions::getNick(), Actions::outString(), outStringNormal(), saveToLogFile(), ChatWindow::selectTabByType(), and PopupMenu::showChatPopup().

◆ handleCommand()

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

inlinevirtual

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 in WhisperTab, PartyTab, GuildTab, EmulateGuildTab, and ChannelTab.

Definition at line 128 of file chattab.h.

130 { return false; }

Referenced by ChatWindow::closeTab(), handleCommands(), and handleCommandStr().

◆ handleCommands()

bool ChatTab::handleCommands	(	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

Definition at line 461 of file chattab.cpp.

 {
     // need split to commands and call each
  
     return handleCommand(type, args);
 }

References handleCommand().

◆ handleCommandStr()

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

protectedvirtual

Reimplemented in WhisperTab, and GmTab.

Definition at line 441 of file chattab.cpp.

 {
     const size_t pos = msg.find(' ');
     const std::string type(msg, 0, pos);
     std::string args(msg, pos == std::string::npos ? msg.size() : pos + 1);
  
     args = trim(args);
     if (!handleCommand(type, args))
         inputManager.executeChatCommand(type, args, this);
 }

References InputManager::executeChatCommand(), handleCommand(), inputManager, Actions::msg(), and Catch::trim().

Referenced by chatInput(), and WhisperTab::handleCommandStr().

◆ handleHelp()

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

protectedvirtual

Definition at line 452 of file chattab.cpp.

 {
     if (helpWindow != nullptr)
     {
         helpWindow->search(msg);
         helpWindow->requestMoveToTop();
     }
 }

References helpWindow, Actions::msg(), Widget::requestMoveToTop(), and HelpWindow::search().

Referenced by chatInput().

◆ handleInput()

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

protectedvirtual

Reimplemented in WhisperTab, TradeTab, PartyTab, GuildTab, GmTab, EmulateGuildTab, ClanTab, and ChannelTab.

Definition at line 433 of file chattab.cpp.

 {
     if (chatHandler)
     {
         chatHandler->talk(ChatWindow::doReplace(msg));
     }
 }

References chatHandler, ChatWindow::doReplace(), Actions::msg(), and Net::ChatHandler::talk().

Referenced by chatInput().

◆ hasRows()

bool ChatTab::hasRows ( ) const

inline

Definition at line 153 of file chattab.h.

154 { return mTextOutput->hasRows(); }

BrowserBox::hasRows

bool hasRows() const

Definition: browserbox.h:127

References BrowserBox::hasRows(), and mTextOutput.

Referenced by ChatWindow::keyPressed().

◆ loadFromLogFile()

void ChatTab::loadFromLogFile ( const std::string & name )

Definition at line 510 of file chattab.cpp.

 {
     if (chatLogger != nullptr)
     {
         std::list<std::string> list;
         chatLogger->loadLast(name, list, 5);
         std::list<std::string>::const_iterator i = list.begin();
         while (i != list.end())
         {
             std::string line("##o" + *i);
             addRow(line);
             ++i;
         }
     }
 }

References addRow(), chatLogger, and ChatLogger::loadLast().

Referenced by ChatWindow::addChannelTab(), ChatWindow::addWhisperTab(), BattleTab::BattleTab(), createGuiWindows(), Ea::PartyRecv::createTab(), EAthena::ClanRecv::createTab(), GuildManager::createTab(), and EAthena::GuildRecv::processGuildPositionInfo().

◆ playNewMessageSound()

void ChatTab::playNewMessageSound ( ) const

virtual

Reimplemented in PartyTab, GuildTab, EmulateGuildTab, and ClanTab.

Definition at line 542 of file chattab.cpp.

 {
     soundManager.playGuiSound(SOUND_WHISPER);
 }

References SoundManager::playGuiSound(), SOUND_WHISPER, and soundManager.

Referenced by chatLog().

◆ saveToLogFile()

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

Definition at line 468 of file chattab.cpp.

 {
     if (chatLogger != nullptr)
     {
         if (getType() == ChatTabType::INPUT)
         {
             chatLogger->log(msg);
         }
         else if (getType() == ChatTabType::DEBUG)
         {
             if (config.getBoolValue("enableDebugLog"))
                 chatLogger->log("#Debug", msg);
         }
         else if (!mLogName.empty())
         {
             chatLogger->log(mLogName, msg);
         }
     }
 }

References chatLogger, config, ChatTabType::DEBUG, Configuration::getBoolValue(), getType(), ChatTabType::INPUT, ChatLogger::log(), mLogName, and Actions::msg().

Referenced by chatLog().

◆ scroll()

void ChatTab::scroll ( const int amount )

Scrolls the chat window

Parameters

amount direction and amount to scroll. Negative numbers scroll up, positive numbers scroll down. The absolute amount indicates the amount of 1/8ths of chat window real estate that should be scrolled.

Definition at line 419 of file chattab.cpp.

 {
     const int range = mScrollArea->getHeight() / 8 * amount;
     Rect scr;
     scr.y = mScrollArea->getVerticalScrollAmount() + range;
     scr.height = abs(range);
     mTextOutput->showPart(scr);
 }

References Widget::getHeight(), ScrollArea::getVerticalScrollAmount(), Rect::height, mScrollArea, mTextOutput, Widget::showPart(), and Rect::y.

Referenced by ChatWindow::scroll().

◆ setAllowHighlight()

void ChatTab::setAllowHighlight ( const bool n )

inline

Definition at line 161 of file chattab.h.

162 { mAllowHightlight = n; }

References mAllowHightlight.

Referenced by ChatWindow::addChannelTab(), ChatWindow::addSpecialChannelTab(), createGuiWindows(), WindowManager::createWindows(), and ChatWindow::loadState().

◆ setCurrent()

void ChatTab::setCurrent ( )

inlineprotectedvirtual

Reimplemented from Tab.

Definition at line 190 of file chattab.h.

191 { setFlash(0); }

References Tab::setFlash().

◆ setNoAway()

void ChatTab::setNoAway ( const bool n )

inline

Definition at line 173 of file chattab.h.

174 { mNoAway = n; }

References mNoAway.

Referenced by ChatWindow::loadState().

◆ setRemoveNames()

void ChatTab::setRemoveNames ( const bool n )

inline

Definition at line 167 of file chattab.h.

168 { mRemoveNames = n; }

References mRemoveNames.

Referenced by ChatWindow::loadState().

◆ showOnline()

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

Definition at line 547 of file chattab.cpp.

 {
     if (!mShowOnline)
         return;
  
     if (online == Online_true)
     {
         // TRANSLATORS: chat message
         chatLog(strprintf(_("%s is now Online."), nick.c_str()),
             ChatMsgType::BY_SERVER,
             IgnoreRecord_false,
             TryRemoveColors_true);
     }
     else
     {
         // TRANSLATORS: chat message
         chatLog(strprintf(_("%s is now Offline."), nick.c_str()),
             ChatMsgType::BY_SERVER,
             IgnoreRecord_false,
             TryRemoveColors_true);
     }
 }

References _, ChatMsgType::BY_SERVER, chatLog(), IgnoreRecord_false, mShowOnline, Online_true, strprintf(), and TryRemoveColors_true.

Referenced by GuildManager::process(), EAthena::GuildRecv::processGuildMemberLogin(), EAthena::PartyRecv::processPartyInfo(), TmwAthena::PartyRecv::processPartyInfo(), EAthena::PartyRecv::processPartyMemberInfo(), and TmwAthena::PartyRecv::processPartyMove().

Friends And Related Function Documentation

◆ ChatWindow

friend class ChatWindow

friend

Definition at line 187 of file chattab.h.

◆ WhisperWindow

friend class WhisperWindow

friend

Definition at line 188 of file chattab.h.

Field Documentation

◆ mAllowHightlight

bool ChatTab::mAllowHightlight

protected

Definition at line 212 of file chattab.h.

Referenced by getAllowHighlight(), and setAllowHighlight().

◆ mChannelName

std::string ChatTab::mChannelName

protected

Definition at line 209 of file chattab.h.

Referenced by ChannelTab::getAutoCompleteCommands(), getChannelName(), ChannelTab::handleInput(), GmTab::handleInput(), TradeTab::handleInput(), and ChannelTab::~ChannelTab().

◆ mLogName

std::string ChatTab::mLogName

protected

Definition at line 210 of file chattab.h.

Referenced by saveToLogFile().

◆ mNoAway

bool ChatTab::mNoAway

protected

Definition at line 214 of file chattab.h.

Referenced by getNoAway(), and setNoAway().

◆ mRemoveNames

bool ChatTab::mRemoveNames

protected

Definition at line 213 of file chattab.h.

Referenced by getRemoveNames(), and setRemoveNames().

◆ mScrollArea

ScrollArea* ChatTab::mScrollArea

protected

Definition at line 208 of file chattab.h.

Referenced by addNewRow(), ChatWindow::addTab(), ChatWindow::adjustTabSize(), chatLog(), ChatTab(), scroll(), and ~ChatTab().

◆ mShowOnline

bool ChatTab::mShowOnline

protected

Definition at line 215 of file chattab.h.

Referenced by EmulateGuildTab::EmulateGuildTab(), GuildTab::GuildTab(), EmulateGuildTab::optionChanged(), GuildTab::optionChanged(), PartyTab::optionChanged(), PartyTab::PartyTab(), and showOnline().

◆ mTextOutput

BrowserBox* ChatTab::mTextOutput

protected

Definition at line 207 of file chattab.h.

Referenced by addRow(), chatLog(), ChatTab(), clearText(), ChatWindow::copyToClipboard(), getRows(), hasRows(), scroll(), and ~ChatTab().

◆ mType

ChatTabTypeT ChatTab::mType

protected

Definition at line 211 of file chattab.h.

Referenced by getType().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ChatTab()

◆ ~ChatTab()

Member Function Documentation

◆ addNewRow()

◆ addRow()

◆ chatInput()

◆ chatLog() [1/2]

◆ chatLog() [2/2]

◆ clearText()

◆ getAllowHighlight()

◆ getAutoCompleteCommands()

◆ getAutoCompleteList()

◆ getChannelName()

◆ getNoAway()

◆ getRemoveNames()

◆ getRows()

◆ getType()

◆ handleCommand()

◆ handleCommands()

◆ handleCommandStr()

◆ handleHelp()

◆ handleInput()

◆ hasRows()

◆ loadFromLogFile()

◆ playNewMessageSound()

◆ saveToLogFile()

◆ scroll()

◆ setAllowHighlight()

◆ setCurrent()

◆ setNoAway()

◆ setRemoveNames()

◆ showOnline()

Friends And Related Function Documentation

◆ ChatWindow

◆ WhisperWindow

Field Documentation

◆ mAllowHightlight

◆ mChannelName

◆ mLogName

◆ mNoAway

◆ mRemoveNames

◆ mScrollArea

◆ mShowOnline

◆ mTextOutput

◆ mType