You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
420 lines
11 KiB
420 lines
11 KiB
/*
|
|
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 <tqptrdict.h>
|
|
|
|
class TQTimer;
|
|
|
|
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 TQString &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 TQString &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 TQString &statusText();
|
|
|
|
TQString &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 TQWidget *mainWidget();
|
|
|
|
KTextEdit *editWidget();
|
|
|
|
bool canSend();
|
|
|
|
/** Reimplemented from KopeteView **/
|
|
virtual void registerContextMenuHandler( TQObject *target, const char* slot );
|
|
|
|
/** Reimplemented from KopeteView **/
|
|
virtual void registerTooltipHandler( TQObject *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 TQColor(), then
|
|
* a color chooser dialog is opened
|
|
*/
|
|
void setFgColor( const TQColor &newColor = TQColor() );
|
|
|
|
/**
|
|
* Sets the font of the edit area and outgoing messages to the specified value.
|
|
* @param newFont The new font to use.
|
|
*/
|
|
void setFont( const TQFont &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
|
|
*/
|
|
TQFont font();
|
|
|
|
/**
|
|
* Sets the background color of the entry area, and outgoing messages
|
|
* @param newColor The new background color. If this is TQColor(), then
|
|
* a color chooser dialog is opened
|
|
*/
|
|
void setBgColor( const TQColor &newColor = TQColor() );
|
|
|
|
/**
|
|
* 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 TQString &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 TQString& );
|
|
|
|
/** Emitted when the state of the chat changes */
|
|
void updateChatState( ChatView*, int );
|
|
|
|
/** Emitted when a possible tab label needs updating */
|
|
void updateChatLabel( ChatView*, const TQString& );
|
|
|
|
/**
|
|
* 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 TQString &key, const TQVariant &oldValue, const TQVariant &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 TQString& 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 TQString &oldValue, const TQString &newValue);
|
|
|
|
protected:
|
|
virtual void dragEnterEvent ( TQDragEnterEvent * );
|
|
virtual void dropEvent ( TQDropEvent * );
|
|
|
|
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
|
|
TQPtrDict<TQTimer> m_remoteTypingMap;
|
|
TQString unreadMessageFrom;
|
|
TQString 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 TQString &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(TQObject *parent, const char *name, const TQStringList &args);
|
|
KopeteView* createView( Kopete::ChatSession *manager );
|
|
};
|
|
|
|
#endif
|