KVIrc 5.2.6
Developer APIs
KviIdentityProfile Class Reference

Class which manages the identity profile. More...

#include <KviIdentityProfile.h>

+ Inheritance diagram for KviIdentityProfile:

Public Member Functions

const QString & altNick () const
 Returns the alternative nickname of the profile.
 
void copyFrom (const KviIdentityProfile &src)
 Carbon copy.
 
 KviIdentityProfile ()
 Constructs the identity profile object.
 
bool load (KviConfigurationFile *pCfg, const QString &szPrefix)
 Loads the configuration from file.
 
const QString & name () const
 Returns the name of the profile.
 
const QString & network () const
 Returns the network of the profile.
 
const QString & nick () const
 Returns the nickname of the profile.
 
const QString & realName () const
 Returns the realname of the profile.
 
void save (KviConfigurationFile *pCfg, const QString &szPrefix)
 Saves the configuration to file.
 
void setAltNick (const QString &szAltNick)
 Sets the alternative nickname of the profile.
 
void setName (const QString &szName)
 Sets the name of the profile.
 
void setNetwork (const QString &szNetwork)
 Sets the network of the profile.
 
void setNick (const QString &szNick)
 Sets the nickname of the profile.
 
void setRealName (const QString &szRealName)
 Sets the realname of the profile.
 
void setUserName (const QString &szUserName)
 Sets the username of the profile.
 
const QString & userName () const
 Returns the username of the profile.
 
 ~KviIdentityProfile ()
 Destroys the identity profile object.
 

Protected Attributes

QString m_szAltNick
 
QString m_szName
 
QString m_szNetwork
 
QString m_szNick
 
QString m_szRealName
 
QString m_szUserName
 

Detailed Description

Class which manages the identity profile.

Constructor & Destructor Documentation

◆ KviIdentityProfile()

KviIdentityProfile::KviIdentityProfile ( )

Constructs the identity profile object.

Returns
KviIdentityProfile

◆ ~KviIdentityProfile()

KviIdentityProfile::~KviIdentityProfile ( )
default

Destroys the identity profile object.

Returns
KviIdentityProfile

Member Function Documentation

◆ altNick()

const QString & KviIdentityProfile::altNick ( ) const
inline

Returns the alternative nickname of the profile.

Returns
const QString &

Referenced by OptionsWidget_identityProfile::addProfileEntry(), IdentityProfileEditor::editProfile(), and OptionsWidget_identityProfile::editProfileEntry().

◆ copyFrom()

void KviIdentityProfile::copyFrom ( const KviIdentityProfile & src)

Carbon copy.

Parameters
srcThe source profile
Returns
void

References m_szAltNick, m_szName, m_szNetwork, m_szNick, m_szRealName, and m_szUserName.

Referenced by KviIdentityProfileSet::copyFrom().

◆ load()

bool KviIdentityProfile::load ( KviConfigurationFile * pCfg,
const QString & szPrefix )

Loads the configuration from file.

Returns false if the loaded data has no sense

Parameters
pCfgThe configuration file
szPrefixThe prefix to use
Returns
bool

References m_szAltNick, m_szName, m_szNetwork, m_szNick, m_szRealName, m_szUserName, and KviConfigurationFile::readEntry().

Referenced by KviIdentityProfileSet::loadPrivate().

◆ name()

const QString & KviIdentityProfile::name ( ) const
inline

◆ network()

const QString & KviIdentityProfile::network ( ) const
inline

◆ nick()

const QString & KviIdentityProfile::nick ( ) const
inline

◆ realName()

const QString & KviIdentityProfile::realName ( ) const
inline

◆ save()

void KviIdentityProfile::save ( KviConfigurationFile * pCfg,
const QString & szPrefix )

Saves the configuration to file.

Parameters
pCfgThe configuration file
szPrefixThe prefix to use
Returns
void

References m_szAltNick, m_szName, m_szNetwork, m_szNick, m_szRealName, m_szUserName, and KviConfigurationFile::writeEntry().

◆ setAltNick()

void KviIdentityProfile::setAltNick ( const QString & szAltNick)
inline

Sets the alternative nickname of the profile.

Parameters
szAltNickThe alternative nickname of the profile
Returns
void

Referenced by OptionsWidget_identityProfile::commit(), IdentityProfileEditor::editProfile(), and OptionsWidget_identityProfile::editProfileEntry().

◆ setName()

void KviIdentityProfile::setName ( const QString & szName)
inline

Sets the name of the profile.

Parameters
szNameThe name of the profile
Returns
void

Referenced by OptionsWidget_identityProfile::commit(), IdentityProfileEditor::editProfile(), and OptionsWidget_identityProfile::editProfileEntry().

◆ setNetwork()

void KviIdentityProfile::setNetwork ( const QString & szNetwork)
inline

Sets the network of the profile.

Parameters
szNetworkThe network of the profile
Returns
void

Referenced by OptionsWidget_identityProfile::commit(), IdentityProfileEditor::editProfile(), and OptionsWidget_identityProfile::editProfileEntry().

◆ setNick()

void KviIdentityProfile::setNick ( const QString & szNick)
inline

Sets the nickname of the profile.

Parameters
szNickThe nickname of the profile
Returns
void

Referenced by OptionsWidget_identityProfile::commit(), IdentityProfileEditor::editProfile(), and OptionsWidget_identityProfile::editProfileEntry().

◆ setRealName()

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

Sets the realname of the profile.

Parameters
szRealNameThe realname of the profile
Returns
void

Referenced by OptionsWidget_identityProfile::commit(), IdentityProfileEditor::editProfile(), and OptionsWidget_identityProfile::editProfileEntry().

◆ setUserName()

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

Sets the username of the profile.

Parameters
szUserNameThe username of the profile
Returns
void

Referenced by OptionsWidget_identityProfile::commit(), IdentityProfileEditor::editProfile(), and OptionsWidget_identityProfile::editProfileEntry().

◆ userName()

const QString & KviIdentityProfile::userName ( ) const
inline

Member Data Documentation

◆ m_szAltNick

QString KviIdentityProfile::m_szAltNick
protected

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

◆ m_szName

QString KviIdentityProfile::m_szName
protected

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

◆ m_szNetwork

QString KviIdentityProfile::m_szNetwork
protected

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

◆ m_szNick

QString KviIdentityProfile::m_szNick
protected

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

◆ m_szRealName

QString KviIdentityProfile::m_szRealName
protected

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

◆ m_szUserName

QString KviIdentityProfile::m_szUserName
protected

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


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