IrcTopicMessage Class Reference

Represents a topic message.

#include <IrcMessage>

Inherits IrcMessage.

Public Member Functions
Q_INVOKABLE	IrcTopicMessage (IrcConnection *connection)
QString	channel () const
QString	topic () const
Public Member Functions inherited from IrcMessage
Q_INVOKABLE	IrcMessage (IrcConnection *connection)
	~IrcMessage () override
QString	account () const
Q_INVOKABLE IrcMessage *	clone (QObject *parent=nullptr) const
QString	command () const
IrcConnection *	connection () const
QByteArray	encoding () const
Flags	flags () const
QString	host () const
QString	ident () const
IrcNetwork *	network () const
QString	nick () const
QString	parameter (int index) const
QStringList	parameters () const
QString	prefix () const
Q_INVOKABLE void	setFlag (Flag flag, bool on=true)
void	setParameter (int index, const QString &parameter)
void	setTag (const QString &name, const QVariant &tag)
QVariant	tag (const QString &name) const
QVariantMap	tags () const
Q_INVOKABLE bool	testFlag (Flag flag) const
QDateTime	timeStamp () const
Q_INVOKABLE QByteArray	toData () const
Type	type () const

Properties
bool	reply
Properties inherited from IrcMessage
bool	implicit
bool	own
bool	valid

Additional Inherited Members
Public Types inherited from IrcMessage
enum	Flag {   None = 0x00 , Own = 0x01 , Identified = 0x02 , Unidentified = 0x04 ,   Playback = 0x08 , Implicit = 0x10 }
enum	Type {   Unknown , Capability , Error , Invite ,   Join , Kick , Mode , Motd ,   Names , Nick , Notice , Numeric ,   Part , Ping , Pong , Private ,   Quit , Topic , WhoReply , Account ,   Away , Whois , Whowas , HostChange ,   Batch }
Static Public Member Functions inherited from IrcMessage
static Q_INVOKABLE IrcMessage *	fromData (const QByteArray &data, IrcConnection *connection)
static Q_INVOKABLE IrcMessage *	fromParameters (const QString &prefix, const QString &command, const QStringList &parameters, IrcConnection *connection)

Constructor & Destructor Documentation

IrcTopicMessage()

IrcTopicMessage::IrcTopicMessage ( IrcConnection * connection )

explicit

Constructs a new IrcTopicMessage with connection.

Member Function Documentation

channel()

QString IrcTopicMessage::channel

(

)

const

This property holds the channel in question.

Access function:

• QString channel() const

topic()

QString IrcTopicMessage::topic

(

)

const

This property holds the new channel topic.

Access function:

• QString topic() const

Property Documentation

reply

bool IrcTopicMessage::reply

read

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