KviUserIdentity Class Reference

User identity handling class. More...

#include <KviUserIdentity.h>

Inheritance diagram for KviUserIdentity:

Public Member Functions
const QString &	age () const
	Returns the age of the user. More...
const QString &	altNickName1 () const
	Returns the alternative nickname of the user. More...
const QString &	altNickName2 () const
	Returns the second alternative nickname of the user. More...
const QString &	altNickName3 () const
	Returns the third alternative nickanem of the user. More...
const KviPixmap &	avatar () const
	Returns the avatar of the user. More...
const QString &	gender () const
	Returns the gender of the user. More...
const QString &	id () const
	Returns the id of the user. More...
	KviUserIdentity ()
	Constructs the user identity object. More...
const QString &	languages () const
	Returns the languages of the user. More...
const QString &	location () const
	Returns the location of the user. More...
const QString &	nickName () const
	Returns the nickname of the user. More...
const QString &	onConnectCommand () const
	Returns the list of commands to run on connection. More...
const QString &	onLoginCommand () const
	Returns the list of commands to run on login. More...
const QString &	otherInfo () const
	Returns the other info field of the user. More...
const QString &	partMessage () const
	Returns the part message of the user. More...
const QString &	password () const
	Returns the password of the user. More...
const QString &	quitMessage () const
	Returns the quit message of the user. More...
void	setAge (const QString &szAge)
	Sets the age of the user. More...
void	setAltNickName1 (const QString &szNickName)
	Sets the alternative nickname of the user. More...
void	setAltNickName2 (const QString &szNickName)
	Sets the second alternative nickname of the user. More...
void	setAltNickName3 (const QString &szNickName)
	Sets the third alternative nickname of the user. More...
void	setAvatar (const KviPixmap &pix)
	Sets the avatar of the user. More...
void	setGender (const QString &szGender)
	Sets the gender of the user. More...
void	setId (const QString &szId)
	Sets the id of the user. More...
void	setLanguages (const QString &szLanguages)
	Sets the languages of the user. More...
void	setLocation (const QString &szLocation)
	Sets the location of the user. More...
void	setNickName (const QString &szNickName)
	Sets the nickname of the user. More...
void	setOnConnectCommand (const QString &szOnConnectCommand)
	Sets the commands list to run on connection. More...
void	setOnLoginCommand (const QString &szOnLoginCommand)
	Sets the commands list to run on login. More...
void	setOtherInfo (const QString &szOtherInfo)
	Sets the other info for the user. More...
void	setPartMessage (const QString &szMsg)
	Sets the part messaege of the user. More...
void	setPassword (const QString &szPassword)
	Sets the password of the user. More...
void	setQuitMessage (const QString &szMsg)
	Sets the quit messaege of the user. More...
void	setRealName (const QString &szRealName)
	Sets the realname of the user. More...
void	setUserMode (const QString &szUserMode)
	Sets the user mode of the user. More...
void	setUserName (const QString &szUserName)
	Sets the username of the user. More...
const QString &	userMode () const
	Returns the user mode of the user. More...
const QString &	userName () const
	Returns the username of the user. More...
	~KviUserIdentity ()
	Destroys the user identity object. More...

Protected Member Functions
void	copyFrom (const KviUserIdentity &src)
	Carbon copy. More...
bool	load (KviConfigurationFile &cfg)
	Loads the user identity. More...
bool	save (KviConfigurationFile &cfg)
	Saves the user identity. More...

Protected Attributes
KviPixmap	m_pixAvatar
QString	m_szAge
QString	m_szAltNickName1
QString	m_szAltNickName2
QString	m_szAltNickName3
QString	m_szGender
QString	m_szId
QString	m_szLanguages
QString	m_szLocation
QString	m_szNickName
QString	m_szOnConnectCommand
QString	m_szOnLoginCommand
QString	m_szOtherInfo
QString	m_szPartMessage
QString	m_szPassword
QString	m_szQuitMessage
QString	m_szRealName
QString	m_szUserMode
QString	m_szUserName

Friends
class	KviUserIdentityManager

Detailed Description

User identity handling class.

Constructor & Destructor Documentation

KviUserIdentity::KviUserIdentity

(

)

Constructs the user identity object.

Returns

KviUserIdentity

KviUserIdentity::~KviUserIdentity ( )

default

Destroys the user identity object.

Member Function Documentation

const QString& KviUserIdentity::age ( ) const

inline

Returns the age of the user.

Returns

const QString &

const QString& KviUserIdentity::altNickName1 ( ) const

inline

Returns the alternative nickname of the user.

Returns

const QString &

const QString& KviUserIdentity::altNickName2 ( ) const

inline

Returns the second alternative nickname of the user.

Returns

const QString &

const QString& KviUserIdentity::altNickName3 ( ) const

inline

Returns the third alternative nickanem of the user.

Returns

const QString &

const KviPixmap& KviUserIdentity::avatar ( ) const

inline

Returns the avatar of the user.

Returns

KviPixmap

void KviUserIdentity::copyFrom ( const KviUserIdentity &  src )

protected

Carbon copy.

Parameters

src	The source user identity

Returns

void

References m_pixAvatar, m_szAge, m_szAltNickName1, m_szAltNickName2, m_szAltNickName3, m_szGender, m_szId, m_szLanguages, m_szLocation, m_szNickName, m_szOnConnectCommand, m_szOnLoginCommand, m_szOtherInfo, m_szPartMessage, m_szPassword, m_szQuitMessage, m_szRealName, m_szUserMode, and m_szUserName.

Referenced by KviUserIdentityManager::copyFrom().

const QString& KviUserIdentity::gender ( ) const

inline

Returns the gender of the user.

Returns

const QString &

const QString& KviUserIdentity::id ( ) const

inline

Returns the id of the user.

Returns

const QString &

Referenced by KviUserIdentityManager::copyFrom(), KviUserIdentityManager::defaultIdentity(), and KviUserIdentityManager::load().

const QString& KviUserIdentity::languages ( ) const

inline

Returns the languages of the user.

Returns

const QString &

bool KviUserIdentity::load ( KviConfigurationFile &  cfg )

protected

Loads the user identity.

Parameters

cfg	The config file where to load

Returns

bool

References KviConfigurationFile::group(), m_pixAvatar, m_szAge, m_szAltNickName1, m_szAltNickName2, m_szAltNickName3, m_szGender, m_szId, m_szLanguages, m_szLocation, m_szNickName, m_szOnConnectCommand, m_szOnLoginCommand, m_szOtherInfo, m_szPartMessage, m_szPassword, m_szQuitMessage, m_szUserMode, m_szUserName, KviConfigurationFile::readEntry(), and KviConfigurationFile::readPixmapEntry().

Referenced by KviUserIdentityManager::load().

const QString& KviUserIdentity::location ( ) const

inline

Returns the location of the user.

Returns

const QString &

const QString& KviUserIdentity::nickName ( ) const

inline

Returns the nickname of the user.

Returns

const QString &

const QString& KviUserIdentity::onConnectCommand ( ) const

inline

Returns the list of commands to run on connection.

Returns

const QString &

Referenced by KviIrcConnection::loginToIrcServer().

const QString& KviUserIdentity::onLoginCommand ( ) const

inline

Returns the list of commands to run on login.

Returns

const QString &

Referenced by KviIrcConnection::loginComplete().

const QString& KviUserIdentity::otherInfo ( ) const

inline

Returns the other info field of the user.

Returns

const QString &

const QString& KviUserIdentity::partMessage ( ) const

inline

Returns the part message of the user.

Returns

const QString &

const QString& KviUserIdentity::password ( ) const

inline

Returns the password of the user.

Returns

const QString &

const QString& KviUserIdentity::quitMessage ( ) const

inline

Returns the quit message of the user.

Returns

const QString &

bool KviUserIdentity::save ( KviConfigurationFile &  cfg )

protected

Saves the user identity.

Parameters

cfg	The config file where to save

Returns

bool

References m_pixAvatar, m_szAge, m_szAltNickName1, m_szAltNickName2, m_szAltNickName3, m_szGender, m_szId, m_szLanguages, m_szLocation, m_szNickName, m_szOnConnectCommand, m_szOnLoginCommand, m_szOtherInfo, m_szPartMessage, m_szPassword, m_szQuitMessage, m_szUserMode, m_szUserName, KviConfigurationFile::setGroup(), and KviConfigurationFile::writeEntry().

void KviUserIdentity::setAge ( const QString &  szAge )

inline

Sets the age of the user.

Parameters

szAge

The age of the user

Returns

void

void KviUserIdentity::setAltNickName1 ( const QString &  szNickName )

inline

Sets the alternative nickname of the user.

Parameters

szNickName

The nickname of the user

Returns

void

Referenced by KviUserIdentityManager::defaultIdentity().

void KviUserIdentity::setAltNickName2 ( const QString &  szNickName )

inline

Sets the second alternative nickname of the user.

Parameters

szNickName

The nickname of the user

Returns

void

Referenced by KviUserIdentityManager::defaultIdentity().

void KviUserIdentity::setAltNickName3 ( const QString &  szNickName )

inline

Sets the third alternative nickname of the user.

Parameters

szNickName

The nickname of the user

Returns

void

Referenced by KviUserIdentityManager::defaultIdentity().

void KviUserIdentity::setAvatar ( const KviPixmap &  pix )

inline

Sets the avatar of the user.

Parameters

pix	The avatar of the user

Returns

void

void KviUserIdentity::setGender ( const QString &  szGender )

inline

Sets the gender of the user.

Parameters

szGender

The gemder of the user

Returns

void

void KviUserIdentity::setId ( const QString &  szId )

inline

Sets the id of the user.

Parameters

szId	The id of the user

Returns

void

Referenced by KviUserIdentityManager::defaultIdentity().

void KviUserIdentity::setLanguages ( const QString &  szLanguages )

inline

Sets the languages of the user.

Parameters

szLanguages

The languages of the user

Returns

void

void KviUserIdentity::setLocation ( const QString &  szLocation )

inline

Sets the location of the user.

Parameters

szLocation

The location of the user

Returns

void

void KviUserIdentity::setNickName ( const QString &  szNickName )

inline

Sets the nickname of the user.

Parameters

szNickName

The nickname of the user

Returns

void

Referenced by KviUserIdentityManager::defaultIdentity().

void KviUserIdentity::setOnConnectCommand ( const QString &  szOnConnectCommand )

inline

Sets the commands list to run on connection.

Parameters

szOnConnectCommand

The commands to run

Returns

void

void KviUserIdentity::setOnLoginCommand ( const QString &  szOnLoginCommand )

inline

Sets the commands list to run on login.

Parameters

szOnLoginCommand

The commands to run

Returns

void

void KviUserIdentity::setOtherInfo ( const QString &  szOtherInfo )

inline

Sets the other info for the user.

Parameters

szOtherInfo

The other info of the user

Returns

void

void KviUserIdentity::setPartMessage ( const QString &  szMsg )

inline

Sets the part messaege of the user.

Parameters

szMsg

The part message of the user

Returns

void

Referenced by KviUserIdentityManager::defaultIdentity().

void KviUserIdentity::setPassword ( const QString &  szPassword )

inline

Sets the password of the user.

Parameters

szPassword

The password of the user

Returns

void

void KviUserIdentity::setQuitMessage ( const QString &  szMsg )

inline

Sets the quit messaege of the user.

Parameters

szMsg

The quit message of the user

Returns

void

Referenced by KviUserIdentityManager::defaultIdentity().

void KviUserIdentity::setRealName ( const QString &  szRealName )

inline

Sets the realname of the user.

Parameters

szRealName

The realname of the user

Returns

void

Referenced by KviUserIdentityManager::defaultIdentity().

void KviUserIdentity::setUserMode ( const QString &  szUserMode )

inline

Sets the user mode of the user.

Parameters

szUserMode

The user mode of the user

Returns

void

void KviUserIdentity::setUserName ( const QString &  szUserName )

inline

Sets the username of the user.

Parameters

szUserName

The username of the user

Returns

void

Referenced by KviUserIdentityManager::defaultIdentity().

const QString& KviUserIdentity::userMode ( ) const

inline

Returns the user mode of the user.

Returns

const QString &

const QString& KviUserIdentity::userName ( ) const

inline

Returns the username of the user.

Returns

const QString &

Friends And Related Function Documentation

friend class KviUserIdentityManager

friend

Member Data Documentation

KviPixmap KviUserIdentity::m_pixAvatar

protected

Referenced by copyFrom(), load(), and save().

QString KviUserIdentity::m_szAge

protected

Referenced by copyFrom(), load(), and save().

QString KviUserIdentity::m_szAltNickName1

protected

Referenced by copyFrom(), load(), and save().

QString KviUserIdentity::m_szAltNickName2

protected

Referenced by copyFrom(), load(), and save().

QString KviUserIdentity::m_szAltNickName3

protected

Referenced by copyFrom(), load(), and save().

QString KviUserIdentity::m_szGender

protected

Referenced by copyFrom(), load(), and save().

QString KviUserIdentity::m_szId

protected

Referenced by copyFrom(), load(), and save().

QString KviUserIdentity::m_szLanguages

protected

Referenced by copyFrom(), load(), and save().

QString KviUserIdentity::m_szLocation

protected

Referenced by copyFrom(), load(), and save().

QString KviUserIdentity::m_szNickName

protected

Referenced by copyFrom(), load(), and save().

QString KviUserIdentity::m_szOnConnectCommand

protected

Referenced by copyFrom(), load(), and save().

QString KviUserIdentity::m_szOnLoginCommand

protected

Referenced by copyFrom(), load(), and save().

QString KviUserIdentity::m_szOtherInfo

protected

Referenced by copyFrom(), load(), and save().

QString KviUserIdentity::m_szPartMessage

protected

Referenced by copyFrom(), load(), and save().

QString KviUserIdentity::m_szPassword

protected

Referenced by copyFrom(), load(), and save().

QString KviUserIdentity::m_szQuitMessage

protected

Referenced by copyFrom(), load(), and save().

QString KviUserIdentity::m_szRealName

protected

Referenced by copyFrom().

QString KviUserIdentity::m_szUserMode

protected

Referenced by copyFrom(), load(), and save().

QString KviUserIdentity::m_szUserName

protected

Referenced by copyFrom(), load(), and save().

---

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

• src/kvilib/irc/KviUserIdentity.h
• src/kvilib/irc/KviUserIdentity.cpp