Class type that is used for conversations within a channel. More...

#include <ircchanneladapter.h>

Inheritance diagram for IRCChannelAdapter:

Signals
void	myNicknameUsed ()
	Emitted when nickname is used in a message. More...

void	nameAdded (const IRCUserInfo &userInfo)

void	nameListUpdated (const IRCUserList &names)

void	nameRemoved (const IRCUserInfo &userInfo)

void	nameUpdated (const IRCUserInfo &userInfo)

Signals inherited from IRCAdapterBase
void	error (const QString &error)

void	focusRequest ()
	Called when this adapter requests UI focus. More...

void	message (const QString &message)

void	messageToNetworksCurrentChatBox (const QString &message, const IRCMessageClass &msgClass)

void	messageWithClass (const QString &message, const IRCMessageClass &messageClass)

void	terminating ()

void	titleChange ()
	Can be called when the variable returned by title() might have changed and the application should be notified of this fact. More...

Public Member Functions
	IRCChannelAdapter (IRCNetworkAdapter *pNetwork, const QString &recipient)

AdapterType	adapterType () const
	Gets adapter type for this adapter instance. More...

bool	amIOperator () const
	Checks if this client is an operator on this channel. More...

void	appendNamesToCachedList (const QStringList &names)
	Appends a list of names to cachedNames list. This ensures that no duplicate names are found on the list. More...

void	appendNameToCachedList (const QString &name)
	Appends a single name to the sorted cachedNames list. More...

void	banUser (const QString &nickname, const QString &reason)
	Bans and kicks user from the channel. More...

void	emitCachedNameListUpdated ()
	Emits cached list of names. This should be called when end of names list message is received for this channel. More...

void	emitChatMessage (const QString &sender, const QString &content)
	Emits message() signal formatting it to present sender's message. More...

bool	hasUser (const QString &nickname)

bool	isOperator (const QString &nickname) const
	Checks if user is an operator on this channel. More...

void	kickUser (const QString &nickname, const QString &reason)
	Kicks user from the channel. More...

void	removeNameFromCachedList (const QString &name)
	Removes a name from the sortecd cachedNames list. More...

void	setHalfOp (const QString &nickname, bool bSet)
	Sets half op mode for given user. More...

void	setOp (const QString &nickname, bool bSet)
	Sets op mode for given user. More...

void	setVoiced (const QString &nickname, bool bSet)
	Sets voice mode for given user. More...

void	userChangesNickname (const QString &oldNickname, const QString &newNickname)

void	userJoins (const QString &nickname, const QString &fullSignature)
	Use this to register the fact that user has joined the chat. More...

void	userLeaves (const QString &nickname, const QString &farewellMessage, IRCQuitType quitType)
	Use this to register the fact that user has left the chat. More...

void	userModeChanges (const QString &nickname, const QList< char > &addedFlags, const QList< char > &removedFlags)

Public Member Functions inherited from IRCChatAdapter
	IRCChatAdapter (IRCNetworkAdapter *pNetwork, const QString &recipient)

void	doSendMessage (const QString &message, IRCAdapterBase *pOrigin)

IRCNetworkAdapter *	network ()
	The idea of the adapter system is that each adapter is either a network or is a child of a network. More...

QString	recipient () const

void	setNetwork (IRCNetworkAdapter *pNetwork)
	Sets IRCNetworkAdapter for this chat window. This adapter is not detached from the old network. More...

QString	title () const
	For chat adapters this will return recipientName. More...

Public Member Functions inherited from IRCAdapterBase
virtual	~IRCAdapterBase ()
	Destructor emits terminating() signal. More...

void	emitError (const QString &strError)

void	emitFocusRequest ()

void	emitMessage (const QString &strMessage)

void	emitMessageWithClass (const QString &strMessage, const IRCMessageClass &messageClass)

const IRCNetworkEntity &	networkEntity () const

Additional Inherited Members
Public Types inherited from IRCChatAdapter
enum	IRCQuitType { ChannelPart, NetworkKill, NetworkQuit }

Public Types inherited from IRCAdapterBase
enum	AdapterType { NetworkAdapter, ChannelAdapter, PrivAdapter }
	Defines all possible types of IRC adapters. More...

Public Slots inherited from IRCAdapterBase
void	emitMessageToAllChatBoxes (const QString &message, const IRCMessageClass &msgClass)

void	sendMessage (const QString &message)

Protected Member Functions inherited from IRCChatAdapter
QString	extractMessageLine (QStringList &words, int maxLength)

void	sendChatMessage (const QString &message)

void	setRecipient (const QString &name)

Protected Attributes inherited from IRCChatAdapter
IRCNetworkAdapter *	pNetwork

QString	recipientName

Detailed Description

Class type that is used for conversations within a channel.

Definition at line 35 of file ircchanneladapter.h.

Member Function Documentation

AdapterType IRCChannelAdapter::adapterType ( ) const

inlinevirtual

Gets adapter type for this adapter instance.

Implements IRCAdapterBase.

Definition at line 43 of file ircchanneladapter.h.

bool IRCChannelAdapter::amIOperator ( ) const

Checks if this client is an operator on this channel.

Definition at line 47 of file ircchanneladapter.cpp.

void IRCChannelAdapter::appendNamesToCachedList ( const QStringList & names )

Appends a list of names to cachedNames list. This ensures that no duplicate names are found on the list.

Definition at line 62 of file ircchanneladapter.cpp.

void IRCChannelAdapter::appendNameToCachedList ( const QString & name )

Appends a single name to the sorted cachedNames list.

Ensures that no duplicate names are found on the lsit. This will emit nameAdded() signal.

Definition at line 53 of file ircchanneladapter.cpp.

void IRCChannelAdapter::banUser	(	const QString &	nickname,
		const QString &	reason
	)

Bans and kicks user from the channel.

Op privileges required.

Parameters

nickname	Victim's nick.
reason	Reason for ban (this will be delivered to /kick message).

Definition at line 70 of file ircchanneladapter.cpp.

void IRCChannelAdapter::emitCachedNameListUpdated ( )

Emits cached list of names. This should be called when end of names list message is received for this channel.

Definition at line 75 of file ircchanneladapter.cpp.

void IRCChannelAdapter::emitChatMessage	(	const QString &	sender,
		const QString &	content
	)

virtual

Emits message() signal formatting it to present sender's message.

Reimplemented from IRCChatAdapter.

Definition at line 80 of file ircchanneladapter.cpp.

bool IRCChannelAdapter::isOperator ( const QString & nickname ) const

Checks if user is an operator on this channel.

Definition at line 108 of file ircchanneladapter.cpp.

void IRCChannelAdapter::kickUser	(	const QString &	nickname,
		const QString &	reason
	)

Kicks user from the channel.

Op privileges required.

Parameters

nickname	Victim's nick.
reason	Reason for kick.

Definition at line 119 of file ircchanneladapter.cpp.

void IRCChannelAdapter::myNicknameUsed ( )

signal

Emitted when nickname is used in a message.

This is played for other user's chat messages.

void IRCChannelAdapter::removeNameFromCachedList ( const QString & name )

Removes a name from the sortecd cachedNames list.

This will emit nameRemoved() signal.

Definition at line 128 of file ircchanneladapter.cpp.

void IRCChannelAdapter::setHalfOp	(	const QString &	nickname,
		bool	bSet
	)

Sets half op mode for given user.

Definition at line 142 of file ircchanneladapter.cpp.

void IRCChannelAdapter::setOp	(	const QString &	nickname,
		bool	bSet
	)

Sets op mode for given user.

Op privileges required.

Definition at line 147 of file ircchanneladapter.cpp.

void IRCChannelAdapter::setVoiced	(	const QString &	nickname,
		bool	bSet
	)

Sets voice mode for given user.

Op privileges required.

Definition at line 152 of file ircchanneladapter.cpp.

void IRCChannelAdapter::userChangesNickname	(	const QString &	oldNickname,
		const QString &	newNickname
	)

virtual

This will emit nameRemoved() for oldNickname and nameAdded() for the newNickname.

Implements IRCChatAdapter.

Definition at line 157 of file ircchanneladapter.cpp.

void IRCChannelAdapter::userJoins	(	const QString &	nickname,
		const QString &	fullSignature
	)

virtual

Use this to register the fact that user has joined the chat.

Implements IRCChatAdapter.

Definition at line 172 of file ircchanneladapter.cpp.

void IRCChannelAdapter::userLeaves	(	const QString &	nickname,
		const QString &	farewellMessage,
		IRCQuitType	quitType
	)

virtual

Use this to register the fact that user has left the chat.

Implements IRCChatAdapter.

Definition at line 180 of file ircchanneladapter.cpp.

void IRCChannelAdapter::userModeChanges	(	const QString &	nickname,
		const QList< char > &	addedFlags,
		const QList< char > &	removedFlags
	)

virtual

this will first emit nameRemoved() for the nickname and then nameAdded() for the same nickname.

Implements IRCChatAdapter.

Definition at line 213 of file ircchanneladapter.cpp.

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

src/core/irc/ircchanneladapter.h
src/core/irc/ircchanneladapter.cpp

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation