kopete/kopete

ChatTextEditPart Class Reference

#include <chattexteditpart.h>

Inheritance diagram for ChatTextEditPart:

Detailed Description

An instant message composition part.

This class provides an input part suitable for the composition of instant messages. It provides command history, nickname completion and typing notifications. It is also able to determine whether the send button should be enabled.

Author:: Richard Smith

Definition at line 53 of file chattexteditpart.h.


Public Slots
void	historyUp ()
void	historyDown ()
void	complete ()
void	sendMessage ()
Signals
void	messageSent (Kopete::Message &message)
void	typing (bool typing)
void	canSendChanged (bool canSend)
Public Member Functions
	ChatTextEditPart (Kopete::ChatSession session, QWidget parent)
	~ChatTextEditPart ()
Kopete::Message	contents ()
void	setContents (const Kopete::Message &message)
void	addText (const QString &text)
bool	canSend ()
bool	isTyping ()
void	toggleAutoSpellCheck (bool enabled)
bool	autoSpellCheckEnabled () const

Constructor & Destructor Documentation

ChatTextEditPart::ChatTextEditPart	(	Kopete::ChatSession *	session,
		QWidget *	parent
	)

Definition at line 35 of file chattexteditpart.cpp.

ChatTextEditPart::~ChatTextEditPart ( )

Definition at line 82 of file chattexteditpart.cpp.

Member Function Documentation

Kopete::Message ChatTextEditPart::contents ( )

Returns the message currently in the edit area.

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

Definition at line 414 of file chattexteditpart.cpp.

void ChatTextEditPart::setContents ( const Kopete::Message & message )

Sets the message in the edit field.

Parameters:

message

The message to display

Definition at line 402 of file chattexteditpart.cpp.

void ChatTextEditPart::addText ( const QString & text )

Adds text into the edit area.

Used when an emoticon is selected.

Parameters:

text

The text to be inserted

Definition at line 390 of file chattexteditpart.cpp.

bool ChatTextEditPart::canSend ( )

Can we send messages now?

Definition at line 223 of file chattexteditpart.cpp.

bool ChatTextEditPart::isTyping ( )

Is the user typing right now?

Definition at line 302 of file chattexteditpart.cpp.

void ChatTextEditPart::toggleAutoSpellCheck ( bool enabled )

Enable or Disable the automatic spell checking.

Parameters:

enabled

the state that auto spell checking should beee

Definition at line 87 of file chattexteditpart.cpp.

bool ChatTextEditPart::autoSpellCheckEnabled ( ) const

Get the state of auto spell checking.

Returns:: true if auto spell checking is turned on, false otherwise

Definition at line 101 of file chattexteditpart.cpp.

void ChatTextEditPart::historyUp ( ) [slot]

Go up an entry in the message history.

Definition at line 332 of file chattexteditpart.cpp.

void ChatTextEditPart::historyDown ( ) [slot]

Go down an entry in the message history.

Definition at line 364 of file chattexteditpart.cpp.

void ChatTextEditPart::complete ( ) [slot]

Try to complete the word under the cursor.

Definition at line 126 of file chattexteditpart.cpp.

void ChatTextEditPart::sendMessage ( ) [slot]

Sends the text currently entered into the edit area.

Definition at line 268 of file chattexteditpart.cpp.

void ChatTextEditPart::messageSent ( Kopete::Message & message ) [signal]

Emitted when a message is sent.

Parameters:

message

The message sent

void ChatTextEditPart::typing ( bool typing ) [signal]

Emitted every 4 seconds while the user is typing.

Parameters:

typing true if the user is typing, false otherwise

void ChatTextEditPart::canSendChanged ( bool canSend ) [signal]

Our send-button-enabled flag might have changed.

Parameters:

canSend

The return value of canSend().

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

kopete/kopete

ChatTextEditPart Class Reference

Detailed Description

Public Slots

Signals

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

kopete/kopete

kdenetwork