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 Types | Public Member Functions | Properties | List of all members
IrcModeMessage Class Reference

Represents a mode message.

Inherits IrcMessage.

Public Types

enum  Kind { Channel, User }
 
- 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
}
 

Public Member Functions

Q_INVOKABLE IrcModeMessage (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 argument
 
Kind kind
 
QString mode
 
QString target
 
- 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

- 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)
 

Member Enumeration Documentation

This enum describes the kind of modes.

Enumerator
Channel 

Channel mode.

User 

User mode.

Constructor & Destructor Documentation

IrcModeMessage::IrcModeMessage ( IrcConnection connection)
explicit

Constructs a new IrcModeMessage with connection.

Member Function Documentation

bool IrcModeMessage::isReply ( ) const

This property holds whether the message is a reply.

Mode messages are sent when a mode changes (false) and when joining a channel (true).

Access function:
  • bool isReply() const
See Also
Irc::RPL_CHANNELMODEIS

Property Documentation

QString IrcModeMessage::argument
read

This property holds the mode argument.

Access function:
IrcModeMessage::Kind IrcModeMessage::kind
read

This property holds the kind of the mode.

Access function:
  • Kind kind() const
QString IrcModeMessage::mode
read

This property holds the channel or user mode.

Access function:
QString IrcModeMessage::target
read

This property holds the target channel or user in question.

Access function: