Communi  3.4.0
A cross-platform IRC framework written with Qt
Public Slots | Public Member Functions | Properties | List of all members
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 IrcChanneltoChannel ()
 

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 ( QObject parent = 0)
explicit

Constructs a new channel object with parent.

IrcChannel::~IrcChannel ( )
virtual

Destructs the channel object.

Member Function Documentation

void IrcChannel::close ( const QString reason = QString())
slot
Since
3.1

Closes the channel with an optional reason.

See also
IrcBuffer::close(), IrcChannel::part()
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()
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()
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

QString IrcChannel::key
read
Since
3.1

This property holds the channel key.

Access function:
Notifier signal:
  • void keyChanged(const QString& key)
QString IrcChannel::mode
read

This property holds the complete channel mode including possible arguments.

Access function:
Notifier signal:
  • void modeChanged(const QString& mode)
QString IrcChannel::topic
read

This property holds the channel topic.

Access function:
Notifier signal:
  • void topicChanged(const QString& topic)