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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
/*
* The ManaPlus Client
* Copyright (C) 2009 The Mana World Development Team
* Copyright (C) 2009-2010 The Mana Developers
* Copyright (C) 2011-2013 The ManaPlus Developers
*
* 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 CHATTAB_H
#define CHATTAB_H
#include "gui/chatwindow.h"
#include "gui/widgets/browserbox.h"
#include "gui/widgets/tab.h"
#include "localconsts.h"
class ScrollArea;
const std::string GENERAL_CHANNEL = "";
const std::string TRADE_CHANNEL = "";
/**
* A tab for the chat window. This is special to ease chat handling.
*/
class ChatTab : public Tab
{
public:
enum Type
{
TAB_UNKNOWN = 0,
TAB_INPUT,
TAB_WHISPER,
TAB_PARTY,
TAB_GUILD,
TAB_DEBUG,
TAB_TRADE,
TAB_BATTLE,
TAB_GM
};
/**
* Constructor.
*/
ChatTab(const Widget2 *const widget, const std::string &name,
const std::string &channel);
A_DELETE_COPY(ChatTab)
~ChatTab();
/**
* Adds a line of text to our message list. Parameters:
*
* @param line Text message.
* @param own Type of message (usually the owner-type).
* @param channelName which channel to send the message to.
* @param ignoreRecord should this not be recorded?
* @param removeColors try remove color if configured
*/
void chatLog(std::string line, Own own = BY_SERVER,
const bool ignoreRecord = false,
const bool tryRemoveColors = true);
/**
* Adds the text to the message list
*
* @param msg The message text which is to be sent.
*/
void chatLog(const std::string &nick, 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(const 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 A_UNUSED,
const std::string &args A_UNUSED)
{ return false; }
/**
* 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 handleCommands(const std::string &type,
const std::string &args);
/**
* Returns type of the being.
*/
virtual int getType() const A_WARN_UNUSED;
virtual void saveToLogFile(std::string &msg);
std::list<std::string> &getRows() const A_WARN_UNUSED
{ return mTextOutput->getRows(); }
bool hasRows() const A_WARN_UNUSED
{ return mTextOutput->hasRows(); }
void loadFromLogFile(std::string name);
bool getAllowHighlight() const A_WARN_UNUSED
{ return mAllowHightlight; }
void setAllowHighlight(const bool n)
{ mAllowHightlight = n; }
bool getRemoveNames() const A_WARN_UNUSED
{ return mRemoveNames; }
void setRemoveNames(const bool n)
{ mRemoveNames = n; }
bool getNoAway() const A_WARN_UNUSED
{ return mNoAway; }
void setNoAway(const bool n)
{ mNoAway = n; }
void addNewRow(std::string &line);
void showOnline(const std::string &nick,
const bool isOnline);
virtual void playNewMessageSound();
std::string getChannelName()
{ return mChannelName; }
protected:
friend class ChatWindow;
friend class WhisperWindow;
virtual void setCurrent() override
{ setFlash(0); }
virtual void handleInput(const std::string &msg);
virtual void handleCommand(const std::string &msg);
virtual void handleHelp(const std::string &msg);
virtual void getAutoCompleteList(StringVect&) const
{}
void addRow(std::string &line);
BrowserBox *mTextOutput;
ScrollArea *mScrollArea;
bool mAllowHightlight;
bool mRemoveNames;
bool mNoAway;
bool mShowOnline;
std::string mChannelName;
};
extern ChatTab *localChatTab;
extern ChatTab *debugChatTab;
#endif // CHATTAB_H
|
