chattab.h

Go to the documentation of this file.

/*
 *  The ManaPlus Client
 *  Copyright (C) 2009  The Mana World Development Team
 *  Copyright (C) 2009-2010  The Mana Developers
 *  Copyright (C) 2011-2019  The ManaPlus Developers
 *  Copyright (C) 2019-2021  Andrei Karas
 *
 *  This file is part of The ManaPlus Client.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef GUI_WIDGETS_TABS_CHAT_CHATTAB_H
#define GUI_WIDGETS_TABS_CHAT_CHATTAB_H
 
#include "enums/gui/chatmsgtype.h"
#include "enums/gui/chattabtype.h"
 
#include "enums/simpletypes/ignorerecord.h"
#include "enums/simpletypes/online.h"
#include "enums/simpletypes/tryremovecolors.h"
 
#include "gui/widgets/browserbox.h"
 
#include "gui/widgets/tabs/tab.h"
 
#include "localconsts.h"
 
class ScrollArea;
 
#define debugMsg(str) \
    if (debugChatTab) \
    { \
        debugChatTab->chatLog(str, \
            ChatMsgType::BY_SERVER, \
            IgnoreRecord_false, \
            TryRemoveColors_true); \
    }
 
#define setTabColors(name) \
    setTabColor(&getThemeColor(name, 255U), \
        &getThemeColor(name##_OUTLINE, 255U)); \
    setHighlightedTabColor(&getThemeColor(name##_HIGHLIGHTED, 255U), \
        &getThemeColor(name##_HIGHLIGHTED_OUTLINE, 255U)); \
    setSelectedTabColor(&getThemeColor(name##_SELECTED, 255U), \
        &getThemeColor(name##_SELECTED_OUTLINE, 255U))
 
class ChatTab notfinal : public Tab
{
    public:
        ChatTab(const Widget2 *const widget,
                const std::string &name,
                const std::string &channel,
                const std::string &logName,
                const ChatTabTypeT &type);
 
        A_DELETE_COPY(ChatTab)
 
        ~ChatTab() override;
 
        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 &restrict type A_UNUSED,
                                   const std::string &restrict args A_UNUSED)
        { return false; }
 
        virtual bool handleCommands(const std::string &type,
                                    const std::string &args);
 
        ChatTabTypeT getType() const noexcept2 A_WARN_UNUSED
        { return mType; }
 
        void saveToLogFile(const std::string &msg) const;
 
        const std::list<std::string> &getRows() const A_WARN_UNUSED
        { return mTextOutput->getRows(); }
 
        bool hasRows() const A_WARN_UNUSED
        { return mTextOutput->hasRows(); }
 
        void loadFromLogFile(const std::string &name);
 
        bool getAllowHighlight() const noexcept2 A_WARN_UNUSED
        { return mAllowHightlight; }
 
        void setAllowHighlight(const bool n) noexcept2
        { mAllowHightlight = n; }
 
        bool getRemoveNames() const noexcept2 A_WARN_UNUSED
        { return mRemoveNames; }
 
        void setRemoveNames(const bool n) noexcept2
        { mRemoveNames = n; }
 
        bool getNoAway() const noexcept2 A_WARN_UNUSED
        { return mNoAway; }
 
        void setNoAway(const bool n) noexcept2
        { mNoAway = n; }
 
        void addNewRow(std::string &line);
 
        void showOnline(const std::string &nick,
                        const Online online);
 
        virtual void playNewMessageSound() const;
 
        const std::string &getChannelName() const
        { return mChannelName; }
 
    protected:
        friend class ChatWindow;
        friend class WhisperWindow;
 
        void setCurrent() override final
        { setFlash(0); }
 
        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 A_UNUSED) const
        {}
 
        virtual void getAutoCompleteCommands(StringVect &names A_UNUSED) const
        {}
 
        void addRow(std::string &line);
 
        BrowserBox *mTextOutput A_NONNULLPOINTER;
        ScrollArea *mScrollArea;
        std::string mChannelName;
        std::string mLogName;
        ChatTabTypeT mType;
        bool mAllowHightlight;
        bool mRemoveNames;
        bool mNoAway;
        bool mShowOnline;
};
 
extern ChatTab *localChatTab;
extern ChatTab *debugChatTab;
 
#endif  // GUI_WIDGETS_TABS_CHAT_CHATTAB_H