kopete/kopete

ChatView Class Reference

#include <chatview.h>

Inheritance diagram for ChatView:

[legend]

List of all members.

Detailed Description

Author:: Olivier Goffart

Definition at line 61 of file chatview.h.


Public Types
enum	KopeteTabState { Normal, Highlighted, Changed, Typing, Message, Undefined }
Public Slots
virtual void	appendMessage (Kopete::Message &message)
virtual bool	closeView (bool force=false)
void	copy ()
void	cut ()
QFont	font ()
virtual void	messageSentSuccessfully ()
void	nickComplete ()
void	paste ()
void	remoteTyping (const Kopete::Contact *contact, bool typing)
virtual void	sendMessage ()
void	setBgColor (const QColor &newColor=QColor())
void	setFgColor (const QColor &newColor=QColor())
void	setFont ()
void	setFont (const QFont &newFont)
void	setStatusText (const QString &text)
Signals
void	activated (KopeteView *)
void	autoSpellCheckEnabled (ChatView *, bool)
void	canSendChanged (bool)
void	captionChanged (bool active)
void	closing (KopeteView *)
void	messageSent (Kopete::Message &)
void	messageSuccess (ChatView *)
void	rtfEnabled (ChatView *, bool)
void	shown ()
void	updateChatLabel (ChatView *, const QString &)
void	updateChatState (ChatView *, int)
void	updateChatTooltip (ChatView *, const QString &)
void	updateStatusIcon (ChatView *)
void	windowCreated ()
Public Member Functions
void	addText (const QString &text)
bool	canSend ()
QString &	caption () const
	ChatView (Kopete::ChatSession manager, ChatWindowPlugin parent)
virtual void	clear ()
virtual Kopete::Message	currentMessage ()
ChatTextEditPart *	editPart () const
KTextEdit *	editWidget ()
virtual bool	isVisible ()
void	loadChatSettings ()
virtual QWidget *	mainWidget ()
KopeteChatWindow *	mainWindow () const
virtual void	makeVisible ()
ChatMessagePart *	messagePart () const
virtual void	raise (bool activate=false)
virtual void	registerContextMenuHandler (QObject target, const char slot)
virtual void	registerTooltipHandler (QObject target, const char slot)
void	saveChatSettings ()
void	saveOptions ()
bool	sendInProgress ()
void	setActive (bool value)
void	setCaption (const QString &text, bool modified)
virtual void	setCurrentMessage (const Kopete::Message &newMessage)
void	setMainWindow (KopeteChatWindow *parent)
const QString &	statusText ()
	~ChatView ()
Protected Member Functions
virtual void	dragEnterEvent (QDragEnterEvent *)
virtual void	dropEvent (QDropEvent *)

Member Enumeration Documentation

enum ChatView::KopeteTabState

the state of our chat

Enumerator:

Normal
Highlighted
Changed
Typing
Message
Undefined

Definition at line 69 of file chatview.h.

Constructor & Destructor Documentation

ChatView::ChatView	(	Kopete::ChatSession *	manager,
		ChatWindowPlugin *	parent
	)

Definition at line 73 of file chatview.cpp.

ChatView::~ChatView ( )

Definition at line 166 of file chatview.cpp.

Member Function Documentation

void ChatView::activated ( KopeteView * ) [signal]

void ChatView::addText ( const QString & text )

Adds text into the edit area.

Used when you select an emoticon

Parameters:

text

The text to be inserted

Definition at line 223 of file chatview.cpp.

void ChatView::appendMessage ( Kopete::Message & message ) [virtual, slot]

Called when a message is received from someone.

Parameters:

message

The message received

Definition at line 602 of file chatview.cpp.

void ChatView::autoSpellCheckEnabled	(	ChatView *	,
		bool
	)			`[signal]`

bool ChatView::canSend ( )

Definition at line 185 of file chatview.cpp.

void ChatView::canSendChanged ( bool ) [signal]

Our send-button-enabled flag has changed.

QString & ChatView::caption ( ) const

Definition at line 571 of file chatview.cpp.

void ChatView::captionChanged ( bool active ) [signal]

void ChatView::clear ( ) [virtual]

Clears the chat buffer.

Reimplemented from KopeteView

Definition at line 228 of file chatview.cpp.

bool ChatView::closeView ( bool force = false ) [virtual, slot]

Definition at line 329 of file chatview.cpp.

void ChatView::closing ( KopeteView * ) [signal]

void ChatView::copy ( ) [slot]

Initiates a copy action If there is text selected in the HTML view, that text is copied Otherwise, the entire edit area is copied.

Definition at line 205 of file chatview.cpp.

Kopete::Message ChatView::currentMessage ( ) [virtual]

Returns the message currently in the edit area.

Returns:: The Kopete::Message object for the message

Reimplemented from KopeteView

Definition at line 190 of file chatview.cpp.

void ChatView::cut ( ) [slot]

Initiates a cut action on the edit area of the chat view.

Definition at line 200 of file chatview.cpp.

void ChatView::dragEnterEvent ( QDragEnterEvent * event ) [protected, virtual]

Definition at line 782 of file chatview.cpp.

void ChatView::dropEvent ( QDropEvent * event ) [protected, virtual]

Definition at line 834 of file chatview.cpp.

ChatTextEditPart* ChatView::editPart ( ) const [inline]

Definition at line 72 of file chatview.h.

KTextEdit * ChatView::editWidget ( )

Definition at line 175 of file chatview.cpp.

QFont ChatView::font ( ) [slot]

Get the font used in the format toolbar for Rich Text formatting.

Definition at line 244 of file chatview.cpp.

bool ChatView::isVisible ( ) [virtual]

Reimplemented from KopeteView.

Definition at line 319 of file chatview.cpp.

void ChatView::loadChatSettings ( )

read the chat settings (rich text, auto spelling)

Definition at line 738 of file chatview.cpp.

QWidget * ChatView::mainWidget ( ) [virtual]

Reimplemented from KopeteView.

Definition at line 180 of file chatview.cpp.

KopeteChatWindow* ChatView::mainWindow ( ) const [inline]

Returns the chat window this view is in.

Returns:: The chat window

Definition at line 138 of file chatview.h.

void ChatView::makeVisible ( ) [virtual]

Reimplemented from KopeteView.

Definition at line 296 of file chatview.cpp.

ChatMessagePart* ChatView::messagePart ( ) const [inline]

Definition at line 71 of file chatview.h.

void ChatView::messageSent ( Kopete::Message & ) [signal]

Emitted when a message is sent.

Parameters:

message

The message sent

void ChatView::messageSentSuccessfully ( ) [virtual, slot]

Reimplemented from KopeteView.

Definition at line 700 of file chatview.cpp.

void ChatView::messageSuccess ( ChatView * ) [signal]

void ChatView::nickComplete ( ) [slot]

Definition at line 218 of file chatview.cpp.

void ChatView::paste ( ) [slot]

Initiates a paste action into the edit area of the chat view.

Definition at line 213 of file chatview.cpp.

void ChatView::raise ( bool activate = false ) [virtual]

Reimplemented from KopeteView.

Definition at line 266 of file chatview.cpp.

void ChatView::registerContextMenuHandler	(	QObject *	target,
		const char *	slot
	)			`[virtual]`

Reimplemented from KopeteView.

Definition at line 906 of file chatview.cpp.

void ChatView::registerTooltipHandler	(	QObject *	target,
		const char *	slot
	)			`[virtual]`

Reimplemented from KopeteView.

Definition at line 915 of file chatview.cpp.

void ChatView::remoteTyping	(	const Kopete::Contact *	contact,
		bool	typing
	)			`[slot]`

Called when a typing event is received from a contact Updates the typing map and outputs the typing message into the status area.

Parameters:

	contact	The contact who is / isn't typing
	typing	If the contact is typing now

Definition at line 401 of file chatview.cpp.

void ChatView::rtfEnabled	(	ChatView *	,
		bool
	)			`[signal]`

Emitted when the state of RTF has changed.

void ChatView::saveChatSettings ( )

save the chat settings (rich text, auto spelling)

Definition at line 715 of file chatview.cpp.

void ChatView::saveOptions ( )

Saves window settings such as splitter positions.

Definition at line 706 of file chatview.cpp.

bool ChatView::sendInProgress ( )

Definition at line 324 of file chatview.cpp.

void ChatView::sendMessage ( ) [virtual, slot]

Sends the text currently entered into the edit area.

Definition at line 694 of file chatview.cpp.

void ChatView::setActive ( bool value )

Tells this view it is the active view.

Definition at line 764 of file chatview.cpp.

void ChatView::setBgColor ( const QColor & newColor = QColor() ) [slot]

Sets the background color of the entry area, and outgoing messages.

Parameters:

newColor

The new background color. If this is QColor(), then a color chooser dialog is opened

Definition at line 233 of file chatview.cpp.

void ChatView::setCaption	(	const QString &	text,
		bool	modified
	)

Sets the text to be displayed on tab label and window caption.

Definition at line 576 of file chatview.cpp.

void ChatView::setCurrentMessage ( const Kopete::Message & newMessage ) [virtual]

Sets the current message in the chat window.

Parameters:

parent

The new chat window

Reimplemented from KopeteView

Definition at line 195 of file chatview.cpp.

void ChatView::setFgColor ( const QColor & newColor = QColor() ) [slot]

Sets the foreground color of the entry area, and outgoing messages.

Parameters:

newColor

The new foreground color. If this is QColor(), then a color chooser dialog is opened

Definition at line 254 of file chatview.cpp.

void ChatView::setFont ( ) [slot]

show a Font dialog and set the font selected by the user

Definition at line 239 of file chatview.cpp.

void ChatView::setFont ( const QFont & newFont ) [slot]

Sets the font of the edit area and outgoing messages to the specified value.

Parameters:

newFont

The new font to use.

Definition at line 249 of file chatview.cpp.

void ChatView::setMainWindow ( KopeteChatWindow * parent )

Changes the pointer to the chat window.

Used to re-parent the view

Parameters:

parent

The new chat window

Definition at line 396 of file chatview.cpp.

void ChatView::setStatusText ( const QString & text ) [slot]

Sets the text to be displayed on the status label.

Parameters:

text

The text to be displayed

Definition at line 447 of file chatview.cpp.

void ChatView::shown ( ) [signal]

Emits when the chat view is shown.

const QString & ChatView::statusText ( )

Definition at line 454 of file chatview.cpp.

void ChatView::updateChatLabel	(	ChatView *	,
		const QString &
	)			`[signal]`

Emitted when a possible tab label needs updating.

void ChatView::updateChatState	(	ChatView *	,
		int
	)			`[signal]`

Emitted when the state of the chat changes.

void ChatView::updateChatTooltip	(	ChatView *	,
		const QString &
	)			`[signal]`

Emitted when a possible tab tooltip needs updating.

void ChatView::updateStatusIcon ( ChatView * ) [signal]

void ChatView::windowCreated ( ) [signal]

Emitted when we re-parent ourselves with a new window.

The documentation for this class was generated from the following files:

kopete/kopete

ChatView Class Reference

Detailed Description

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

kopete/kopete

kdenetwork