chatwindow.h

Go to the documentation of this file.

/*
 *  The Mana Client
 *  Copyright (C) 2004-2009  The Mana World Development Team
 *  Copyright (C) 2009-2012  The Mana Developers
 *
 *  This file is part of The Mana 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/>.
 */
 
#pragma once
 
#include "eventlistener.h"
 
#include "gui/widgets/window.h"
#include "gui/widgets/textfield.h"
 
#include <guichan/actionlistener.hpp>
#include <guichan/keylistener.hpp>
#include <guichan/widget.hpp>
#include <guichan/widgetlistener.hpp>
 
#include <string>
#include <map>
 
class ChatTab;
class ChatInput;
class Recorder;
class TabbedArea;
class ItemLinkHandler;
 
#define DEFAULT_CHAT_WINDOW_SCROLL 7 // 1 means `1/8th of the window size'.
 
enum Own
{
    BY_GM,
    BY_PLAYER,
    BY_OTHER,
    BY_SERVER,
    BY_CHANNEL,
    ACT_WHISPER,      // getting whispered at
    ACT_IS,           // equivalent to "/me" on IRC
    BY_LOGGER
};
 
struct CHATLOG
{
    std::string nick;
    std::string text;
    Own own;
};
 
class ChatWindow : public Window,
                   public gcn::ActionListener,
                   public EventListener
{
    public:
        ChatWindow();
 
        ~ChatWindow() override;
 
        void resetToDefaultSize() override;
 
        ChatTab *getFocused() const;
 
        void clearTab();
 
        void prevTab();
 
        void nextTab();
 
        void action(const gcn::ActionEvent &event) override;
 
        bool requestChatFocus();
 
        bool isInputFocused() const;
 
        void chatInput(const std::string &msg);
 
        void addInputText(const std::string &text);
 
        void addItemText(const std::string &item);
 
        void setVisible(bool visible) override;
 
        void mousePressed(gcn::MouseEvent &event) override;
        void mouseDragged(gcn::MouseEvent &event) override;
 
        void event(Event::Channel channel, const Event &event) override;
 
        void scroll(int amount);
 
        void setRecordingFile(const std::string &msg);
 
        void doPresent();
 
        void whisper(const std::string &nick, const std::string &mes,
                     Own own = BY_OTHER);
 
        ChatTab *addWhisperTab(const std::string &nick, bool switchTo = false);
 
    protected:
        friend class ChatTab;
        friend class WhisperTab;
        friend class ChatAutoComplete;
 
        void removeTab(ChatTab *tab);
 
        void addTab(ChatTab *tab);
 
        void removeWhisper(const std::string &nick);
 
        void removeAllWhispers();
 
        ItemLinkHandler *mItemLinkHandler;
        Recorder *mRecorder;
 
        ChatInput *mChatInput;
 
        TextHistory mHistory;
        AutoCompleteLister *mAutoComplete;
 
    private:
        bool mTmpVisible = false;
 
        TabbedArea *mChatTabs;
 
        std::map<const std::string, ChatTab *> mWhispers;
};
 
extern ChatWindow *chatWindow;