1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
/*
* The Mana Client
* Copyright (C) 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/>.
*/
#ifndef CHATTAB_H
#define CHATTAB_H
#include "gui/chatwindow.h"
#include "gui/widgets/tab.h"
#include "gui/widgets/textfield.h"
class BrowserBox;
class Recorder;
class ScrollArea;
/**
* A tab for the chat window. This is special to ease chat handling.
*/
class ChatTab : public Tab, public AutoCompleteLister, public EventListener
{
public:
ChatTab(const std::string &name);
~ChatTab() override;
/**
* Adds a line of text to our message list. Parameters:
*
* @param line Text message.
* @param own Type of message (usually the owner-type).
* @param ignoreRecord should this not be recorded?
*/
void chatLog(std::string line, Own own = BY_SERVER,
bool ignoreRecord = false);
/**
* Adds the text to the message list
*
* @param msg The message text which is to be sent.
*/
void chatLog(const std::string &nick, 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
*
* @param msg The message text which is to be sent.
*/
void chatInput(const std::string &msg);
/**
* Scrolls the chat window
*
* @param 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.
*/
void scroll(int amount);
/**
* Clears the text from the tab
*/
void clearText();
/**
* Add any extra help text to the output. Allows tabs to define help
* for commands defined by the tab itself.
*/
virtual void showHelp() {}
/**
* 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
*/
virtual bool handleCommand(const std::string &type,
const std::string &args)
{ return false; }
void getAutoCompleteList(std::vector<std::string> &names) const override;
virtual void saveToLogFile(std::string &msg);
void event(Event::Channel channel, const Event &event) override;
protected:
friend class ChatWindow;
friend class WhisperWindow;
void setCurrent() override { setFlash(false); }
virtual void handleInput(const std::string &msg);
virtual void handleCommand(const std::string &msg);
/**
* Returns whether a notify sound may be played for the given type of
* message. By default, only returns true for inline whispers.
*
* Is never called for server-messages or when the window has focus
* and this is the current tab.
*/
virtual bool checkNotify(Own own) const;
/**
* Adapts the text format to the current gui opacity,
* for better readability.
*/
void updateTextFormat(int alpha);
void addRow(std::string &line);
ScrollArea *mScrollArea;
BrowserBox *mTextOutput;
//Recorder *mRecorder;
};
extern ChatTab *localChatTab;
#endif // CHATTAB_H
|
