KVIrc 5.2.6
Developer APIs
KviIrcUserDataBase Class Reference

The class which manages the user database. More...

#include <KviIrcUserDataBase.h>

+ Inheritance diagram for KviIrcUserDataBase:

Public Member Functions

void clear ()
 Clears the database.
 
QColor * customColor (const QString &szNick)
 Returns the custom color of the user.
 
KviPointerHashTable< QString, KviIrcUserEntry > * dict ()
 Returns the database dictionary.
 
KviIrcUserEntryfind (const QString &szNick)
 Searches for a user in the database.
 
bool haveCustomColor (const QString &szNick)
 Returns true if the user has custom colors set.
 
KviIrcUserEntryinsertUser (const QString &szNick, const QString &szUser, const QString &szHost)
 Adds the user to the database.
 
 KviIrcUserDataBase ()
 Constructs the Irc user database object.
 
KviRegisteredUserregisteredUser (const QString &szNick)
 Returns the registered user, if any, or 0.
 
KviRegisteredUserregisteredUser (const QString &szNick, const QString &szUser, const QString &szHost)
 Returns the registered user, if any, or 0.
 
bool removeUser (const QString &szNick, KviIrcUserEntry *pEntry)
 Decrements the user reference count and if it reaches 0 then deletes the user from the database.
 
void setupConnectionWithReguserDb ()
 Initialize the database by connecting signals and slots.
 
 ~KviIrcUserDataBase ()
 Destoys the object.
 

Protected Slots

void registeredDatabaseCleared ()
 Slot called when the database is cleared.
 
void registeredUserAdded (const QString &szUser)
 Slot called when a registered user is added.
 
void registeredUserChanged (const QString &szUser)
 Slot called when a registered user is changed or removed.
 

Private Attributes

KviPointerHashTable< QString, KviIrcUserEntry > * m_pDict
 

Detailed Description

The class which manages the user database.

Constructor & Destructor Documentation

◆ KviIrcUserDataBase()

KviIrcUserDataBase::KviIrcUserDataBase ( )

Constructs the Irc user database object.

Returns
KviIrcUserDataBase

References m_pDict, and setupConnectionWithReguserDb().

◆ ~KviIrcUserDataBase()

KviIrcUserDataBase::~KviIrcUserDataBase ( )

Destoys the object.

References m_pDict.

Member Function Documentation

◆ clear()

void KviIrcUserDataBase::clear ( )

Clears the database.

Returns
void

References m_pDict.

◆ customColor()

QColor * KviIrcUserDataBase::customColor ( const QString & szNick)

Returns the custom color of the user.

Parameters
szNickThe nickname of the user
Returns
QColor *

References find(), KviIrcUserEntry::m_bNotFoundRegUserLookup, KviIrcUserEntry::m_cachedColor, KviIrcUserEntry::m_szLastRegisteredMatchNick, and registeredUser().

◆ dict()

KviPointerHashTable< QString, KviIrcUserEntry > * KviIrcUserDataBase::dict ( )
inline

Returns the database dictionary.

Returns
KviPointerHashTable<QString,KviIrcUserEntry> *

References m_pDict.

◆ find()

KviIrcUserEntry * KviIrcUserDataBase::find ( const QString & szNick)
inline

◆ haveCustomColor()

bool KviIrcUserDataBase::haveCustomColor ( const QString & szNick)

Returns true if the user has custom colors set.

Parameters
szNickThe nickname of the user
Returns
bool

References find(), KviIrcUserEntry::m_bNotFoundRegUserLookup, KviIrcUserEntry::m_bUseCustomColor, KviIrcUserEntry::m_szLastRegisteredMatchNick, and registeredUser().

◆ insertUser()

KviIrcUserEntry * KviIrcUserDataBase::insertUser ( const QString & szNick,
const QString & szUser,
const QString & szHost )

Adds the user to the database.

Parameters
szNickThe nickname of the user
szUserThe username of the user
szHostThe hostname of the user
Returns
KviIrcUserEntry *

References KviIrcUserEntry::m_nRefs, m_pDict, KviIrcUserEntry::m_szHost, KviIrcUserEntry::m_szUser, and szHost.

◆ registeredDatabaseCleared

void KviIrcUserDataBase::registeredDatabaseCleared ( )
protectedslot

Slot called when the database is cleared.

Returns
void

References KviPointerHashTableIterator< Key, T >::current(), and m_pDict.

Referenced by setupConnectionWithReguserDb().

◆ registeredUser() [1/2]

◆ registeredUser() [2/2]

◆ registeredUserAdded

void KviIrcUserDataBase::registeredUserAdded ( const QString & szUser)
protectedslot

Slot called when a registered user is added.

Parameters
szUserThe user added
Returns
void

References KviPointerHashTableIterator< Key, T >::current(), and m_pDict.

Referenced by setupConnectionWithReguserDb().

◆ registeredUserChanged

void KviIrcUserDataBase::registeredUserChanged ( const QString & szUser)
protectedslot

Slot called when a registered user is changed or removed.

Parameters
szUserThe user changed
Returns
void

References KviPointerHashTableIterator< Key, T >::current(), and m_pDict.

Referenced by setupConnectionWithReguserDb().

◆ removeUser()

bool KviIrcUserDataBase::removeUser ( const QString & szNick,
KviIrcUserEntry * pEntry )

Decrements the user reference count and if it reaches 0 then deletes the user from the database.

Parameters
szNickThe nickname of the user
pEntryThe entry of the user
Returns
true if the reference count reached 0 and false otherwise (so true if the user was completely deleted from the db)

References KviIrcUserEntry::m_nRefs, and m_pDict.

◆ setupConnectionWithReguserDb()

void KviIrcUserDataBase::setupConnectionWithReguserDb ( )

Initialize the database by connecting signals and slots.

Returns
void

References connect(), g_pRegisteredUserDataBase, registeredDatabaseCleared(), registeredUserAdded(), and registeredUserChanged().

Referenced by KviIrcUserDataBase().

Member Data Documentation

◆ m_pDict


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