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

Protected Member Functions

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

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::KviUserIdentity ( )

Constructs the user identity object.

Returns
KviUserIdentity

◆ ~KviUserIdentity()

KviUserIdentity::~KviUserIdentity ( )
default

Destroys the user identity object.

Member Function Documentation

◆ age()

const QString & KviUserIdentity::age ( ) const
inline

Returns the age of the user.

Returns
const QString &

◆ altNickName1()

const QString & KviUserIdentity::altNickName1 ( ) const
inline

Returns the alternative nickname of the user.

Returns
const QString &

◆ altNickName2()

const QString & KviUserIdentity::altNickName2 ( ) const
inline

Returns the second alternative nickname of the user.

Returns
const QString &

◆ altNickName3()

const QString & KviUserIdentity::altNickName3 ( ) const
inline

Returns the third alternative nickanem of the user.

Returns
const QString &

◆ avatar()

const KviPixmap & KviUserIdentity::avatar ( ) const
inline

Returns the avatar of the user.

Returns
KviPixmap

◆ copyFrom()

void KviUserIdentity::copyFrom ( const KviUserIdentity src)
protected

◆ gender()

const QString & KviUserIdentity::gender ( ) const
inline

Returns the gender of the user.

Returns
const QString &

◆ id()

const QString & KviUserIdentity::id ( ) const
inline

Returns the id of the user.

Returns
const QString &

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

◆ languages()

const QString & KviUserIdentity::languages ( ) const
inline

Returns the languages of the user.

Returns
const QString &

◆ load()

bool KviUserIdentity::load ( KviConfigurationFile cfg)
protected

◆ location()

const QString & KviUserIdentity::location ( ) const
inline

Returns the location of the user.

Returns
const QString &

◆ nickName()

const QString & KviUserIdentity::nickName ( ) const
inline

Returns the nickname of the user.

Returns
const QString &

◆ onConnectCommand()

const QString & KviUserIdentity::onConnectCommand ( ) const
inline

Returns the list of commands to run on connection.

Returns
const QString &

Referenced by KviIrcConnection::loginToIrcServer().

◆ onLoginCommand()

const QString & KviUserIdentity::onLoginCommand ( ) const
inline

Returns the list of commands to run on login.

Returns
const QString &

Referenced by KviIrcConnection::loginComplete().

◆ otherInfo()

const QString & KviUserIdentity::otherInfo ( ) const
inline

Returns the other info field of the user.

Returns
const QString &

◆ partMessage()

const QString & KviUserIdentity::partMessage ( ) const
inline

Returns the part message of the user.

Returns
const QString &

◆ password()

const QString & KviUserIdentity::password ( ) const
inline

Returns the password of the user.

Returns
const QString &

◆ quitMessage()

const QString & KviUserIdentity::quitMessage ( ) const
inline

Returns the quit message of the user.

Returns
const QString &

◆ save()

bool KviUserIdentity::save ( KviConfigurationFile cfg)
protected

◆ setAge()

void KviUserIdentity::setAge ( const QString &  szAge)
inline

Sets the age of the user.

Parameters
szAgeThe age of the user
Returns
void

◆ setAltNickName1()

void KviUserIdentity::setAltNickName1 ( const QString &  szNickName)
inline

Sets the alternative nickname of the user.

Parameters
szNickNameThe nickname of the user
Returns
void

Referenced by KviUserIdentityManager::defaultIdentity().

◆ setAltNickName2()

void KviUserIdentity::setAltNickName2 ( const QString &  szNickName)
inline

Sets the second alternative nickname of the user.

Parameters
szNickNameThe nickname of the user
Returns
void

Referenced by KviUserIdentityManager::defaultIdentity().

◆ setAltNickName3()

void KviUserIdentity::setAltNickName3 ( const QString &  szNickName)
inline

Sets the third alternative nickname of the user.

Parameters
szNickNameThe nickname of the user
Returns
void

Referenced by KviUserIdentityManager::defaultIdentity().

◆ setAvatar()

void KviUserIdentity::setAvatar ( const KviPixmap pix)
inline

Sets the avatar of the user.

Parameters
pixThe avatar of the user
Returns
void

◆ setGender()

void KviUserIdentity::setGender ( const QString &  szGender)
inline

Sets the gender of the user.

Parameters
szGenderThe gemder of the user
Returns
void

◆ setId()

void KviUserIdentity::setId ( const QString &  szId)
inline

Sets the id of the user.

Parameters
szIdThe id of the user
Returns
void

Referenced by KviUserIdentityManager::defaultIdentity().

◆ setLanguages()

void KviUserIdentity::setLanguages ( const QString &  szLanguages)
inline

Sets the languages of the user.

Parameters
szLanguagesThe languages of the user
Returns
void

◆ setLocation()

void KviUserIdentity::setLocation ( const QString &  szLocation)
inline

Sets the location of the user.

Parameters
szLocationThe location of the user
Returns
void

◆ setNickName()

void KviUserIdentity::setNickName ( const QString &  szNickName)
inline

Sets the nickname of the user.

Parameters
szNickNameThe nickname of the user
Returns
void

Referenced by KviUserIdentityManager::defaultIdentity().

◆ setOnConnectCommand()

void KviUserIdentity::setOnConnectCommand ( const QString &  szOnConnectCommand)
inline

Sets the commands list to run on connection.

Parameters
szOnConnectCommandThe commands to run
Returns
void

◆ setOnLoginCommand()

void KviUserIdentity::setOnLoginCommand ( const QString &  szOnLoginCommand)
inline

Sets the commands list to run on login.

Parameters
szOnLoginCommandThe commands to run
Returns
void

◆ setOtherInfo()

void KviUserIdentity::setOtherInfo ( const QString &  szOtherInfo)
inline

Sets the other info for the user.

Parameters
szOtherInfoThe other info of the user
Returns
void

◆ setPartMessage()

void KviUserIdentity::setPartMessage ( const QString &  szMsg)
inline

Sets the part messaege of the user.

Parameters
szMsgThe part message of the user
Returns
void

Referenced by KviUserIdentityManager::defaultIdentity().

◆ setPassword()

void KviUserIdentity::setPassword ( const QString &  szPassword)
inline

Sets the password of the user.

Parameters
szPasswordThe password of the user
Returns
void

◆ setQuitMessage()

void KviUserIdentity::setQuitMessage ( const QString &  szMsg)
inline

Sets the quit messaege of the user.

Parameters
szMsgThe quit message of the user
Returns
void

Referenced by KviUserIdentityManager::defaultIdentity().

◆ setRealName()

void KviUserIdentity::setRealName ( const QString &  szRealName)
inline

Sets the realname of the user.

Parameters
szRealNameThe realname of the user
Returns
void

Referenced by KviUserIdentityManager::defaultIdentity().

◆ setUserMode()

void KviUserIdentity::setUserMode ( const QString &  szUserMode)
inline

Sets the user mode of the user.

Parameters
szUserModeThe user mode of the user
Returns
void

◆ setUserName()

void KviUserIdentity::setUserName ( const QString &  szUserName)
inline

Sets the username of the user.

Parameters
szUserNameThe username of the user
Returns
void

Referenced by KviUserIdentityManager::defaultIdentity().

◆ userMode()

const QString & KviUserIdentity::userMode ( ) const
inline

Returns the user mode of the user.

Returns
const QString &

◆ userName()

const QString & KviUserIdentity::userName ( ) const
inline

Returns the username of the user.

Returns
const QString &

Friends And Related Symbol Documentation

◆ KviUserIdentityManager

friend class KviUserIdentityManager
friend

Member Data Documentation

◆ m_pixAvatar

KviPixmap KviUserIdentity::m_pixAvatar
protected

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

◆ m_szAge

QString KviUserIdentity::m_szAge
protected

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

◆ m_szAltNickName1

QString KviUserIdentity::m_szAltNickName1
protected

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

◆ m_szAltNickName2

QString KviUserIdentity::m_szAltNickName2
protected

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

◆ m_szAltNickName3

QString KviUserIdentity::m_szAltNickName3
protected

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

◆ m_szGender

QString KviUserIdentity::m_szGender
protected

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

◆ m_szId

QString KviUserIdentity::m_szId
protected

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

◆ m_szLanguages

QString KviUserIdentity::m_szLanguages
protected

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

◆ m_szLocation

QString KviUserIdentity::m_szLocation
protected

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

◆ m_szNickName

QString KviUserIdentity::m_szNickName
protected

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

◆ m_szOnConnectCommand

QString KviUserIdentity::m_szOnConnectCommand
protected

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

◆ m_szOnLoginCommand

QString KviUserIdentity::m_szOnLoginCommand
protected

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

◆ m_szOtherInfo

QString KviUserIdentity::m_szOtherInfo
protected

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

◆ m_szPartMessage

QString KviUserIdentity::m_szPartMessage
protected

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

◆ m_szPassword

QString KviUserIdentity::m_szPassword
protected

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

◆ m_szQuitMessage

QString KviUserIdentity::m_szQuitMessage
protected

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

◆ m_szRealName

QString KviUserIdentity::m_szRealName
protected

Referenced by copyFrom().

◆ m_szUserMode

QString KviUserIdentity::m_szUserMode
protected

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

◆ m_szUserName

QString KviUserIdentity::m_szUserName
protected

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


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