KVIrc: KviIrcUserDataBase Class Reference

KVIrc 4.9.2

DeveloperAPIs

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

#include <KviIrcUserDataBase.h>

Inheritance diagram for KviIrcUserDataBase:

Public Member Functions
void	clear ()
	Clears the database. More...

QColor *	customColor (const QString &szNick)
	Returns the custom color of the user. More...

KviPointerHashTable< QString, KviIrcUserEntry > *	dict ()
	Returns the database dictionary. More...

KviIrcUserEntry *	find (const QString &szNick)
	Searches for a user in the database. More...

bool	haveCustomColor (const QString &szNick)
	Returns true if the user has custom colors set. More...

KviIrcUserEntry *	insertUser (const QString &szNick, const QString &szUser, const QString &szHost)
	Adds the user to the database. More...

	KviIrcUserDataBase ()
	Constructs the Irc user database object. More...

KviRegisteredUser *	registeredUser (const QString &szNick)
	Returns the registered user, if any, or 0. More...

KviRegisteredUser *	registeredUser (const QString &szNick, const QString &szUser, const QString &szHost)
	Returns the registered user, if any, or 0. More...

bool	removeUser (const QString &szNick, KviIrcUserEntry *pEntry)
	Decrements the user reference count and if it reaches 0 then deletes the user from the database. More...

void	setupConnectionWithReguserDb ()
	Initialize the database by connecting signals and slots. More...

	~KviIrcUserDataBase ()
	Destoys the object. More...

Protected Slots
void	registeredDatabaseCleared ()
	Slot called when the database is cleared. More...

void	registeredUserAdded (const QString &szUser)
	Slot called when a registered user is added. More...

void	registeredUserChanged (const QString &szUser)
	Slot called when a registered user is changed or removed. More...

Private Attributes
KviPointerHashTable< QString, KviIrcUserEntry > *	m_pDict

Detailed Description

The class which manages the user database.

Constructor & Destructor Documentation

KviIrcUserDataBase::KviIrcUserDataBase ( )

Constructs the Irc user database object.

Returns: KviIrcUserDataBase

References m_pDict, KviPointerHashTable< Key, T >::setAutoDelete(), and setupConnectionWithReguserDb().

KviIrcUserDataBase::~KviIrcUserDataBase ( )

Destoys the object.

References m_pDict.

Member Function Documentation

void KviIrcUserDataBase::clear ( )

Clears the database.

Returns: void

References m_pDict, and KviPointerHashTable< Key, T >::setAutoDelete().

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

Returns the custom color of the user.

Parameters

szNick The nickname of the user

Returns: QColor *

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

Referenced by KviUserListEntry::color(), and KviUserListViewArea::paintEvent().

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

inline

Returns the database dictionary.

Returns: KviPointerHashTable<QString,KviIrcUserEntry> *

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

inline

Searches for a user in the database.

Parameters

szNick The nickname of the user to find

Returns: KviIrcUserEntry *

Referenced by avatar_kvs_cmd_notify(), avatar_kvs_cmd_set(), avatar_kvs_cmd_unset(), avatar_kvs_fnc_name(), avatar_kvs_fnc_path(), KviConsoleWindow::currentAvatar(), customColor(), KviIrcView::doLinkToolTip(), KviQueryWindow::getInfoLabelText(), KviQueryWindow::getWindowListTipText(), KviIsOnNotifyListManager::handleIsOn(), haveCustomColor(), KviKvsCoreSimpleCommands::KVSCSC(), KviIrcConnection::loginComplete(), KviIrcConnection::loginToIrcServer(), KviConsoleWindow::outputPrivmsg(), KviIrcServerParser::parseCtcpReplyAvatar(), KviIrcServerParser::parseCtcpReplyUserinfo(), KviIrcServerParser::parseLiteralAccount(), KviIrcServerParser::parseLiteralAway(), KviIrcServerParser::parseLiteralChghost(), KviIrcServerParser::parseLiteralJoin(), KviIrcServerParser::parseLiteralKick(), KviIrcServerParser::parseLiteralNick(), KviIrcServerParser::parseNumericWhoisAway(), KviIrcServerParser::parseNumericWhoisServer(), KviIrcServerParser::parseNumericWhoisUser(), KviIrcServerParser::parseNumericWhoReply(), KviIrcServerParser::parseNumericWhospcrpl(), registeredUser(), KviQueryWindow::setAliveQuery(), KviConsoleWindow::setAvatar(), KviConsoleWindow::setAvatarFromOptions(), and KviIrcConnection::userInfoReceived().

bool KviIrcUserDataBase::haveCustomColor ( const QString & szNick )

Returns true if the user has custom colors set.

Parameters

szNick The nickname of the user

Returns: bool

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

Referenced by KviUserListEntry::color(), and KviUserListViewArea::paintEvent().

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

Adds the user to the database.

Parameters

szNick	The nickname of the user
szUser	The username of the user
szHost	The hostname of the user

Returns: KviIrcUserEntry *

References KviPointerHashTable< Key, T >::find(), KviPointerHashTable< Key, T >::insert(), KviIrcUserEntry::m_nRefs, m_pDict, KviIrcUserEntry::m_szHost, KviIrcUserEntry::m_szUser, and szHost.

Referenced by KviUserListView::join().

void KviIrcUserDataBase::registeredDatabaseCleared ( )

protectedslot

Slot called when the database is cleared.

Returns: void

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

Referenced by setupConnectionWithReguserDb().

KviRegisteredUser * KviIrcUserDataBase::registeredUser ( const QString & szNick )

Returns the registered user, if any, or 0.

Parameters

szNick The nickname of the user

Returns: KviRegisteredUser *

References find(), KviIrcUserEntry::host(), and KviIrcUserEntry::user().

Referenced by KviConsoleWindow::applyHighlighting(), KviConsoleWindow::avatarChanged(), KviConsoleWindow::checkDefaultAvatar(), KviUserListEntry::color(), customColor(), haveCustomColor(), KviIrcServerParser::parseCtcpRequest(), KviIrcServerParser::parseCtcpRequestDcc(), KviIrcServerParser::parseLiteralInvite(), KviIrcServerParser::parseLiteralNotice(), KviIrcServerParser::parseLiteralPrivmsg(), and KviConsoleWindow::triggerOnHighlight().

KviRegisteredUser * KviIrcUserDataBase::registeredUser	(	const QString &	szNick,
		const QString &	szUser,
		const QString &	szHost
	)

Returns the registered user, if any, or 0.

Parameters

szNick	The nickname of the user
szUser	The username of the user
szHost	The hostname of the user

Returns: KviRegisteredUser *

References find(), KviRegisteredUserDataBase::findMatchingUser(), KviStringConversion::fromString(), g_pRegisteredUserDataBase, KviRegisteredUser::getBoolProperty(), KviRegisteredUser::getProperty(), KviRegisteredUserDataBase::getUser(), KviIrcUserEntry::hasHost(), KviIrcUserEntry::hasUser(), KviIrcUserEntry::host(), KviIrcUserEntry::m_bNotFoundRegUserLookup, KviIrcUserEntry::m_bUseCustomColor, KviIrcUserEntry::m_cachedColor, KviIrcUserEntry::m_szLastRegisteredMatchNick, KviIrcUserEntry::m_szRegisteredUserName, KviRegisteredUser::name(), and KviIrcUserEntry::user().

void KviIrcUserDataBase::registeredUserAdded ( const QString & szUser )

protectedslot

Slot called when a registered user is added.

Parameters

szUser The user added

Returns: void

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

Referenced by setupConnectionWithReguserDb().

void KviIrcUserDataBase::registeredUserChanged ( const QString & szUser )

protectedslot

Slot called when a registered user is changed or removed.

Parameters

szUser The user changed

Returns: void

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

Referenced by setupConnectionWithReguserDb().

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

szNick	The nickname of the user
pEntry	The 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, m_pDict, and KviPointerHashTable< Key, T >::remove().

Referenced by KviUserListView::partInternal(), and KviUserListView::removeAllEntries().

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

KviPointerHashTable<QString, KviIrcUserEntry>* KviIrcUserDataBase::m_pDict

private

Referenced by clear(), insertUser(), KviIrcUserDataBase(), registeredDatabaseCleared(), registeredUserAdded(), registeredUserChanged(), removeUser(), and ~KviIrcUserDataBase().

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

src/kvilib/irc/KviIrcUserDataBase.h
src/kvilib/irc/KviIrcUserDataBase.cpp