IRCNetworkEntity Class Reference

Data structure that describes and defines a connection to an IRC network or server. More...

#include <ircnetworkentity.h>

Public Member Functions

const QString & address () const
 Address of the server or network to connect to. More...
 
const QStringList & autojoinChannels () const
 List of channels to which a /join command will be issued automatically when a connection with this network is established. More...
 
QStringList & autojoinChannels ()
 
const QStringList & autojoinCommands () const
 List of commands executed on network join. More...
 
QStringList & autojoinCommands ()
 
const QString & description () const
 A short, human-readable description for the network. (Preferably a single word). More...
 
const PatternListignoredUsers () const
 
bool isAutojoinNetwork () const
 Join this network when Doomseeker starts up. More...
 
bool isValid () const
 
const QString & nickservCommand () const
 
const QString & nickservPassword () const
 
bool operator< (const IRCNetworkEntity &other) const
 Sorts by description. More...
 
bool operator== (const IRCNetworkEntity &other) const
 Checks to see if this is the same server. More...
 
const QString & password () const
 Password for the server or network. Ignored if empty. More...
 
unsigned short port () const
 Port of the server or network to connect to. More...
 
QVariant serializeQVariant () const
 
void setAddress (const QString &v)
 
void setAutojoinChannels (const QStringList &v)
 
void setAutojoinCommands (const QStringList &v)
 
void setAutojoinNetwork (bool v)
 
void setDescription (const QString &v)
 
void setIgnoredUsers (const PatternList &val)
 
void setNickservCommand (const QString &v)
 
void setNickservPassword (const QString &v)
 
void setPassword (const QString &v)
 
void setPort (unsigned short v)
 

Static Public Member Functions

static IRCNetworkEntity deserializeQVariant (const QVariant &var)
 

Detailed Description

Data structure that describes and defines a connection to an IRC network or server.

Definition at line 38 of file ircnetworkentity.h.

Member Function Documentation

const QString & IRCNetworkEntity::address ( ) const

Address of the server or network to connect to.

Definition at line 57 of file ircnetworkentity.cpp.

const QStringList & IRCNetworkEntity::autojoinChannels ( ) const

List of channels to which a /join command will be issued automatically when a connection with this network is established.

Definition at line 62 of file ircnetworkentity.cpp.

const QStringList & IRCNetworkEntity::autojoinCommands ( ) const

List of commands executed on network join.

Definition at line 72 of file ircnetworkentity.cpp.

const QString & IRCNetworkEntity::description ( ) const

A short, human-readable description for the network. (Preferably a single word).

Only limited set of characters is allowed in network description, as this description is used to name the directory where chat logs are being kept. These characters are letters, digits, spaces, and also '_' and '-'. All other characters will be automatically converted to '_' by setDescription().

Definition at line 92 of file ircnetworkentity.cpp.

bool IRCNetworkEntity::isAutojoinNetwork ( ) const

Join this network when Doomseeker starts up.

Definition at line 82 of file ircnetworkentity.cpp.

bool IRCNetworkEntity::operator< ( const IRCNetworkEntity other) const

Sorts by description.

Definition at line 107 of file ircnetworkentity.cpp.

bool IRCNetworkEntity::operator== ( const IRCNetworkEntity other) const

Checks to see if this is the same server.

Definition at line 112 of file ircnetworkentity.cpp.

const QString & IRCNetworkEntity::password ( ) const

Password for the server or network. Ignored if empty.

Definition at line 117 of file ircnetworkentity.cpp.

unsigned short IRCNetworkEntity::port ( ) const

Port of the server or network to connect to.

Default value: 6667

Definition at line 122 of file ircnetworkentity.cpp.


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