Communi  3.0.0
A cross-platform IRC framework written with Qt
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Macros Groups Pages
Public Member Functions | Properties | List of all members
IrcTopicMessage Class Reference

Represents a topic message.

Inherits IrcMessage.

Public Member Functions

Q_INVOKABLE IrcTopicMessage (IrcConnection *connection)
 
bool isReply () const
 
- Public Member Functions inherited from IrcMessage
Q_INVOKABLE IrcMessage (IrcConnection *connection)
 
virtual ~IrcMessage ()
 
QByteArray encoding () const
 
Q_INVOKABLE QByteArray toData () const
 

Properties

QString channel
 
QString topic
 
- Properties inherited from IrcMessage
QString command
 
IrcConnection connection
 
Flags flags
 
QString host
 
QString ident
 
IrcNetwork network
 
QString nick
 
QStringList parameters
 
QString prefix
 
QDateTime timeStamp
 
Type type
 
bool valid
 

Additional Inherited Members

- Public Types inherited from IrcMessage
enum  Flag { None = 0x0, Own = 0x1, Identified = 0x2, Unidentified = 0x4 }
 
enum  Type {
  Unknown, Capability, Error, Invite,
  Join, Kick, Mode, Motd,
  Names, Nick, Notice, Numeric,
  Part, Ping, Pong, Private,
  Quit, Topic
}
 
- Static Public Member Functions inherited from IrcMessage
static Q_INVOKABLE IrcMessagefromData (const QByteArray &data, IrcConnection *connection)
 
static Q_INVOKABLE IrcMessagefromParameters (const QString &prefix, const QString &command, const QStringList &parameters, IrcConnection *connection)
 

Constructor & Destructor Documentation

IrcTopicMessage::IrcTopicMessage ( IrcConnection connection)
explicit

Constructs a new IrcTopicMessage with connection.

Member Function Documentation

bool IrcTopicMessage::isReply ( ) const

This property holds whether the message is a reply.

Topic messages are sent in three situations:

  • as a notification of a topic change (false),
  • as a reply when joining a channel (true), or
  • as a reply when explicitly querying the channel topic (true).
Access function:
  • bool isReply() const
See Also
Irc::RPL_TOPIC, Irc::RPL_NOTOPIC, IrcTopicCommand

Property Documentation

QString IrcTopicMessage::channel
read

This property holds the channel in question.

Access function:
QString IrcTopicMessage::topic
read

This property holds the new channel topic.

Access function: