IRCUserInfo Class Reference

Holds information flags about given nickname. More...

#include <ircuserinfo.h>

Public Member Functions

 IRCUserInfo ()
 Creates invalid IRCUserInfo. More...
 
 IRCUserInfo (const QString &nickname, const IRCNetworkAdapter *parentNetwork, const QString &fullSignature="")
 Constructor will set flags based on nickname's prefix. More...
 
QString cleanNickname () const
 Returns nickname with no prefixes, contrary to the prefixedName() . More...
 
QString cleanNicknameLowerCase () const
 Returns cleanNickname() with a call to IRCGlobal::toIrcLower() . More...
 
QString extractHostnameFromFullSignature () const
 
bool isOp () const
 
bool isSameNickname (const IRCUserInfo &otherUser) const
 Check if this user and user specified as parameter are the same user. More...
 
bool isSameNickname (const QString &otherNickname) const
 
bool isValid () const
 
const QList< char > & modes () const
 
const IRCNetworkAdapternetwork () const
 
bool operator<= (const IRCUserInfo &otherUser) const
 This operator can be used for sorting. More...
 
bool operator== (const IRCUserInfo &otherUser) const
 
QString prefixedName () const
 Will generate prefix based on the user flags. More...
 
QString prefixedNameLowerCase () const
 Returns prefixedName() with a call to IRCGlobal::toIrcLower() . More...
 
void setMode (char mode)
 
void setModes (const QList< char > &modes)
 
void setPrefixedNickname (const QString &nickname)
 
void unsetMode (char mode)
 

Public Attributes

QString fullSignature
 Full user signature with nickname and hostname. More...
 

Detailed Description

Holds information flags about given nickname.

Definition at line 35 of file ircuserinfo.h.

Constructor & Destructor Documentation

IRCUserInfo::IRCUserInfo ( )

Creates invalid IRCUserInfo.

isValid() returns false.

Definition at line 30 of file ircuserinfo.cpp.

IRCUserInfo::IRCUserInfo ( const QString &  nickname,
const IRCNetworkAdapter parentNetwork,
const QString &  fullSignature = "" 
)

Constructor will set flags based on nickname's prefix.

Definition at line 35 of file ircuserinfo.cpp.

Member Function Documentation

QString IRCUserInfo::cleanNickname ( ) const

Returns nickname with no prefixes, contrary to the prefixedName() .

Definition at line 50 of file ircuserinfo.cpp.

QString IRCUserInfo::cleanNicknameLowerCase ( ) const

Returns cleanNickname() with a call to IRCGlobal::toIrcLower() .

Definition at line 55 of file ircuserinfo.cpp.

bool IRCUserInfo::isSameNickname ( const IRCUserInfo otherUser) const

Check if this user and user specified as parameter are the same user.

Calls the operator==.

Definition at line 79 of file ircuserinfo.cpp.

bool IRCUserInfo::operator<= ( const IRCUserInfo otherUser) const

This operator can be used for sorting.

Returns
True if this user's nickname is earlier in alphabet than other user's nickname. Also true if this user has one of the following flags over the other user: op, voice (in this order).

Definition at line 122 of file ircuserinfo.cpp.

QString IRCUserInfo::prefixedName ( ) const

Will generate prefix based on the user flags.

Definition at line 139 of file ircuserinfo.cpp.

QString IRCUserInfo::prefixedNameLowerCase ( ) const

Returns prefixedName() with a call to IRCGlobal::toIrcLower() .

Definition at line 154 of file ircuserinfo.cpp.

Member Data Documentation

QString IRCUserInfo::fullSignature

Full user signature with nickname and hostname.

It must be noted that this variable value might not be valid even if IRCUserInfo is containing a valid nickname information. In fact this value will always be empty for chat adapters. However network adapters will require this signature info to deliver bans.

Definition at line 47 of file ircuserinfo.h.


The documentation for this class was generated from the following files: