IrcChannel Class Reference

Keeps track of channel status. More...

Inherits IrcBuffer.

Public Slots
void	close (const QString &reason=QString())
void	join (const QString &key=QString())
void	part (const QString &reason=QString())
void	who ()
Public Slots inherited from IrcBuffer
virtual void	close (const QString &reason=QString())
void	receiveMessage (IrcMessage *message)

Public Member Functions
Q_INVOKABLE	IrcChannel (QObject *parent=0)
virtual	~IrcChannel ()
Public Member Functions inherited from IrcBuffer
Q_INVOKABLE	IrcBuffer (QObject *parent=0)
virtual	~IrcBuffer ()
Q_INVOKABLE bool	sendCommand (IrcCommand *command)
Q_INVOKABLE IrcChannel *	toChannel ()

Properties
QString	key
QString	mode
QString	topic
Properties inherited from IrcBuffer
bool	active
bool	channel
IrcConnection	connection
IrcBufferModel	model
QString	name
IrcNetwork	network
bool	persistent
QString	prefix
bool	sticky
QString	title
QVariantMap	userData

Additional Inherited Members
Signals inherited from IrcBuffer
void	messageReceived (IrcMessage *message)

Detailed Description

See also

IrcBufferModel

Constructor & Destructor Documentation

IrcChannel()

IrcChannel::IrcChannel ( QObject *  parent = 0 )

explicit

Constructs a new channel object with parent.

~IrcChannel()

IrcChannel::~IrcChannel ( )

virtual

Destructs the channel object.

Member Function Documentation

close

void IrcChannel::close ( const QString &  reason = QString() )

slot

Since

3.1

Closes the channel with an optional reason.

See also

IrcBuffer::close(), IrcChannel::part()

join

void IrcChannel::join ( const QString &  key = QString() )

slot

Since

3.1

Joins the channel with an optional key.

This method is provided for convenience. It is equal to:

IrcCommand* command = IrcCommand::createJoin(channel->title(), key);
channel->sendCommand(command);

See also

IrcBuffer::sendCommand(), IrcCommand::createJoin()

part

void IrcChannel::part ( const QString &  reason = QString() )

slot

Parts the channel with an optional reason.

This method is provided for convenience. It is equal to:

IrcCommand* command = IrcCommand::createPart(channel->title(), reason);
channel->sendCommand(command);

See also

IrcBuffer::sendCommand(), IrcCommand::createPart()

who

void IrcChannel::who ( )

slot

Since

3.3

Sends a who command to the channel.

This method is provided for convenience. It is equal to:

IrcCommand* command = IrcCommand::createWho(channel->title());
channel->sendCommand(command);

See also

IrcBuffer::sendCommand(), IrcCommand::createWho()

Property Documentation

key

QString IrcChannel::key

read

Since

3.1

This property holds the channel key.

Access function:

• QString key() const

Notifier signal:

• void keyChanged(const QString& key)

mode

QString IrcChannel::mode

read

This property holds the complete channel mode including possible arguments.

Access function:

• QString mode() const

Notifier signal:

• void modeChanged(const QString& mode)

topic

QString IrcChannel::topic

read

This property holds the channel topic.

Access function:

• QString topic() const

Notifier signal:

• void topicChanged(const QString& topic)