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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
|
/*
chatview.h - Chat View
Copyright (c) 2002-2004 by Olivier Goffart <ogoffart @ kde.org>
Kopete (c) 2002-2004 by the Kopete developers <kopete-devel@kde.org>
*************************************************************************
* *
* 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 *
* (at your option) any later version. *
* *
*************************************************************************
*/
#ifndef CHATVIEW_H
#define CHATVIEW_H
#include "kopeteview.h"
#include "kopeteviewplugin.h"
#include <kdockwidget.h>
#include <ktextedit.h> // for covariant return type of editWidget
#include <qptrdict.h>
class QTimer;
class ChatTextEditPart;
class ChatMembersListWidget;
class ChatMessagePart;
class KopeteChatWindow;
class KTabWidget;
class KopeteChatViewPrivate;
class ChatWindowPlugin;
namespace KParts
{
class Part;
}
namespace Kopete
{
class Contact;
class ChatSession;
}
/**
* @author Olivier Goffart
*/
class ChatView : public KDockMainWindow, public KopeteView
{
Q_OBJECT
public:
ChatView( Kopete::ChatSession *manager, ChatWindowPlugin *parent, const char *name = 0 );
~ChatView();
/** the state of our chat */
enum KopeteTabState { Normal, Highlighted, Changed, Typing, Message, Undefined };
ChatMembersListWidget *membersList() const { return m_membersList; }
ChatMessagePart *messagePart() const { return m_messagePart; }
ChatTextEditPart *editPart() const { return m_editPart; }
/**
* Adds text into the edit area. Used when you select an emoticon
* @param text The text to be inserted
*/
void addText( const QString &text );
/**
* Saves window settings such as splitter positions
*/
void saveOptions();
/**
* Tells this view it is the active view
*/
void setActive( bool value );
/**
* save the chat settings (rich text, auto spelling)
*/
void saveChatSettings();
/**
* read the chat settings (rich text, auto spelling)
*/
void loadChatSettings();
/**
* Clears the chat buffer
*
* Reimplemented from KopeteView
*/
virtual void clear();
/**
* Sets the text to be displayed on tab label and window caption
*/
void setCaption( const QString &text, bool modified );
/**
* Changes the pointer to the chat window. Used to re-parent the view
* @param parent The new chat window
*/
void setMainWindow( KopeteChatWindow* parent );
/**
* Returns the message currently in the edit area
* @return The Kopete::Message object for the message
*
* Reimplemented from KopeteView
*/
virtual Kopete::Message currentMessage();
/**
* Sets the current message in the chat window
* @param parent The new chat window
*
* Reimplemented from KopeteView
*/
virtual void setCurrentMessage( const Kopete::Message &newMessage );
/**
* Sets the placement of the chat members list.
* DockLeft, DockRight, or DockNone.
* @param dp The dock position of the list
*/
void placeMembersList( KDockWidget::DockPosition dp = KDockWidget::DockRight );
/**
* Shows or hides the chat members list
*/
void toggleMembersVisibility();
/**
* Returns the chat window this view is in
* @return The chat window
*/
KopeteChatWindow *mainWindow() const { return m_mainWindow; }
/**
* Returns the current position of the chat member slist
* @return The position of the chat members list
*/
const KDockWidget::DockPosition membersListPosition() { return membersDockPosition; }
/**
* Returns whether or not the chat member list is visible
* @return Is the chat member list visible?
*/
bool visibleMembersList();
const QString &statusText();
QString &caption() const;
bool sendInProgress();
/** Reimplemented from KopeteView **/
virtual void raise( bool activate=false );
/** Reimplemented from KopeteView **/
virtual void makeVisible();
/** Reimplemented from KopeteView **/
virtual bool isVisible();
/** Reimplemented from KopeteView **/
virtual QWidget *mainWidget();
KTextEdit *editWidget();
bool canSend();
/** Reimplemented from KopeteView **/
virtual void registerContextMenuHandler( QObject *target, const char* slot );
/** Reimplemented from KopeteView **/
virtual void registerTooltipHandler( QObject *target, const char* slot );
public slots:
/**
* Initiates a cut action on the edit area of the chat view
*/
void cut();
/**
* Initiates a copy action
* If there is text selected in the HTML view, that text is copied
* Otherwise, the entire edit area is copied.
*/
void copy();
/**
* Initiates a paste action into the edit area of the chat view
*/
void paste();
void nickComplete();
/**
* Sets the foreground color of the entry area, and outgoing messages
* @param newColor The new foreground color. If this is QColor(), then
* a color chooser dialog is opened
*/
void setFgColor( const QColor &newColor = QColor() );
/**
* Sets the font of the edit area and outgoing messages to the specified value.
* @param newFont The new font to use.
*/
void setFont( const QFont &newFont );
/**
* show a Font dialog and set the font selected by the user
*/
void setFont();
/**
* Get the font used in the format toolbar for Rich Text formatting
*/
QFont font();
/**
* Sets the background color of the entry area, and outgoing messages
* @param newColor The new background color. If this is QColor(), then
* a color chooser dialog is opened
*/
void setBgColor( const QColor &newColor = QColor() );
/**
* Sends the text currently entered into the edit area
*/
virtual void sendMessage();
/**
* Called when a message is received from someone
* @param message The message received
*/
virtual void appendMessage( Kopete::Message &message );
/**
* Called when a typing event is received from a contact
* Updates the typing map and outputs the typing message into the status area
* @param contact The contact who is / isn't typing
* @param typing If the contact is typing now
*/
void remoteTyping( const Kopete::Contact *contact, bool typing );
/**
* Sets the text to be displayed on the status label
* @param text The text to be displayed
*/
void setStatusText( const QString &text );
/** Reimplemented from KopeteView **/
virtual void messageSentSuccessfully();
virtual bool closeView( bool force = false );
signals:
/**
* Emitted when a message is sent
* @param message The message sent
*/
void messageSent( Kopete::Message & );
void messageSuccess( ChatView* );
/**
* Emits when the chat view is shown
*/
void shown();
void closing( KopeteView* );
void activated( KopeteView* );
void captionChanged( bool active );
void updateStatusIcon( ChatView* );
/** Emitted when a possible tab tooltip needs updating */
void updateChatTooltip( ChatView*, const QString& );
/** Emitted when the state of the chat changes */
void updateChatState( ChatView*, int );
/** Emitted when a possible tab label needs updating */
void updateChatLabel( ChatView*, const QString& );
/**
* Our send-button-enabled flag has changed
*/
void canSendChanged(bool);
/**
* Emitted when we re-parent ourselves with a new window
*/
void windowCreated();
/**
* Emitted when the state of RTF has changed
*/
void rtfEnabled( ChatView*, bool );
void autoSpellCheckEnabled( ChatView*, bool );
private slots:
void slotRemoteTypingTimeout();
/**
* Show that a contact changed his nickname when a metacontact is not avaiable.
*/
void slotPropertyChanged( Kopete::Contact *contact, const QString &key, const QVariant &oldValue, const QVariant &newValue );
/**
* Called when a contact is added to the chat session.
* Adds this contact to the typingMap and the contact list view
* @param c The contact that joined the chat
* @param suppress mean that no notifications are showed
*/
void slotContactAdded( const Kopete::Contact *c, bool suppress );
/**
* Called when a contact is removed from the chat session. Updates the tab state and status icon,
* displays a notification message and performs some cleanup.
* @param c The contact left the chat
* @param reason is the reason the contact left
* @param format The format of the reason message
* @param suppressNotification mean that no notifications are showed
*/
void slotContactRemoved( const Kopete::Contact *c, const QString& reason, Kopete::Message::MessageFormat format, bool suppressNotification=false );
/**
* Called when a contact changes status, updates the display name, status icon and tab bar state.
* If the user isn't changing to/from an Unknown status, will also display a message in the chatwindow.
* @param contact The contact who changed status
* @param status The new status of the contact
* @param oldstatus The former status of the contact
*/
void slotContactStatusChanged( Kopete::Contact *contact, const Kopete::OnlineStatus &status, const Kopete::OnlineStatus &oldstatus );
/**
* Called when the chat's display name is changed
*/
void slotChatDisplayNameChanged();
void slotMarkMessageRead();
void slotToggleRtfToolbar( bool enabled );
/**
* Show that a (meta)contact change his display name.
*/
void slotDisplayNameChanged(const QString &oldValue, const QString &newValue);
protected:
virtual void dragEnterEvent ( QDragEnterEvent * );
virtual void dropEvent ( QDropEvent * );
private:
// widget stuff
KopeteChatWindow *m_mainWindow;
KDockWidget *viewDock;
ChatMessagePart *m_messagePart;
KDockWidget *membersDock;
ChatMembersListWidget *m_membersList;
KDockWidget *editDock;
ChatTextEditPart *m_editPart;
KopeteTabState m_tabState;
// position and visibility of the chat member list
KDockWidget::DockPosition membersDockPosition;
enum MembersListPolicy { Smart = 0, Visible = 1, Hidden = 2 };
MembersListPolicy membersStatus;
// miscellany
QPtrDict<QTimer> m_remoteTypingMap;
QString unreadMessageFrom;
QString m_status;
void updateChatState( KopeteTabState state = Undefined );
/**
* Creates the members list widget
*/
void createMembersList();
/**
* Read in saved options, such as splitter positions
*/
void readOptions();
void sendInternalMessage( const QString &msg, Kopete::Message::MessageFormat format = Kopete::Message::PlainText );
KopeteChatViewPrivate *d;
};
/**
* This is the class that makes the chatwindow a plugin
*/
class ChatWindowPlugin : public Kopete::ViewPlugin
{
public:
ChatWindowPlugin(QObject *parent, const char *name, const QStringList &args);
KopeteView* createView( Kopete::ChatSession *manager );
};
#endif
// vim: set noet ts=4 sts=4 sw=4:
|