KVIrc 5.2.0
Developer APIs
KviUserIdentity.h
Go to the documentation of this file.
1#ifndef _KVI_USERIDENTITY_H_
2#define _KVI_USERIDENTITY_H_
3//=============================================================================
4//
5// File : KviUserIdentity.h
6// Creation date : Sun 21 Jan 2007 04:31:47 by Szymon Stefanek
7//
8// This file is part of the KVIrc IRC Client distribution
9// Copyright (C) 2007-2010 Szymon Stefanek <pragma at kvirc dot net>
10//
11// This program is FREE software. You can redistribute it and/or
12// modify it under the terms of the GNU General Public License
13// as published by the Free Software Foundation; either version 2
14// of the License, or (at your option) any later version.
15//
16// This program is distributed in the HOPE that it will be USEFUL,
17// but WITHOUT ANY WARRANTY; without even the implied warranty of
18// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
19// See the GNU General Public License for more details.
20//
21// You should have received a copy of the GNU General Public License
22// along with this program. If not, write to the Free Software Foundation,
23// Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24//
25//=============================================================================
26
32#include "kvi_settings.h"
33#include "KviHeapObject.h"
34#include "KviPixmap.h"
35
36#include <QString>
37
39
45{
47
48public:
54
59
60protected:
61 QString m_szId; // the identity set name
62
63 QString m_szNickName;
64
68
69 QString m_szUserName;
70 QString m_szRealName;
71 QString m_szPassword;
72
74
77
78 QString m_szAge;
79 QString m_szGender;
80 QString m_szLocation;
83
84 QString m_szUserMode;
85
88
89public:
94 const QString & id() const { return m_szId; };
95
100 const QString & nickName() const { return m_szNickName; };
101
106 const QString & altNickName1() const { return m_szAltNickName1; };
107
112 const QString & altNickName2() const { return m_szAltNickName2; };
113
118 const QString & altNickName3() const { return m_szAltNickName3; };
119
124 const QString & userName() const { return m_szUserName; };
125
130 const QString & password() const { return m_szPassword; };
131
136 const KviPixmap & avatar() const { return m_pixAvatar; };
137
142 const QString & partMessage() const { return m_szPartMessage; };
143
148 const QString & quitMessage() const { return m_szQuitMessage; };
149
154 const QString & age() const { return m_szAge; };
155
160 const QString & gender() const { return m_szGender; };
161
166 const QString & location() const { return m_szLocation; };
167
172 const QString & languages() const { return m_szLanguages; };
173
178 const QString & otherInfo() const { return m_szOtherInfo; };
179
184 const QString & userMode() const { return m_szUserMode; };
185
190 const QString & onConnectCommand() const { return m_szOnConnectCommand; };
191
196 const QString & onLoginCommand() const { return m_szOnLoginCommand; };
197
203 void setId(const QString & szId) { m_szId = szId; };
204
210 void setNickName(const QString & szNickName) { m_szNickName = szNickName; };
211
217 void setAltNickName1(const QString & szNickName) { m_szAltNickName1 = szNickName; };
218
224 void setAltNickName2(const QString & szNickName) { m_szAltNickName2 = szNickName; };
225
231 void setAltNickName3(const QString & szNickName) { m_szAltNickName3 = szNickName; };
232
238 void setUserName(const QString & szUserName) { m_szUserName = szUserName; };
239
245 void setRealName(const QString & szRealName) { m_szRealName = szRealName; };
246
252 void setPassword(const QString & szPassword) { m_szPassword = szPassword; };
253
259 void setAvatar(const KviPixmap & pix) { m_pixAvatar = pix; };
260
266 void setPartMessage(const QString & szMsg) { m_szPartMessage = szMsg; };
267
273 void setQuitMessage(const QString & szMsg) { m_szQuitMessage = szMsg; };
274
280 void setAge(const QString & szAge) { m_szAge = szAge; };
281
287 void setGender(const QString & szGender) { m_szGender = szGender; };
288
294 void setLocation(const QString & szLocation) { m_szLocation = szLocation; };
295
301 void setLanguages(const QString & szLanguages) { m_szLanguages = szLanguages; };
302
308 void setOtherInfo(const QString & szOtherInfo) { m_szOtherInfo = szOtherInfo; };
309
315 void setUserMode(const QString & szUserMode) { m_szUserMode = szUserMode; };
316
322 void setOnConnectCommand(const QString & szOnConnectCommand) { m_szOnConnectCommand = szOnConnectCommand; };
323
329 void setOnLoginCommand(const QString & szOnLoginCommand) { m_szOnLoginCommand = szOnLoginCommand; };
330protected:
336 void copyFrom(const KviUserIdentity & src);
337
343 bool save(KviConfigurationFile & cfg);
344
350 bool load(KviConfigurationFile & cfg);
351};
352
353#endif // _KVI_USERIDENTITY_H_
Heap Object.
Definition KviConfigurationFile.h:50
Definition KviHeapObject.h:125
Definition KviPixmap.h:35
The class to manage the user identity.
Definition KviUserIdentityManager.h:48
User identity handling class.
Definition KviUserIdentity.h:45
QString m_szLanguages
Definition KviUserIdentity.h:81
const QString & altNickName1() const
Returns the alternative nickname of the user.
Definition KviUserIdentity.h:106
void setNickName(const QString &szNickName)
Sets the nickname of the user.
Definition KviUserIdentity.h:210
QString m_szUserName
Definition KviUserIdentity.h:69
void setPartMessage(const QString &szMsg)
Sets the part messaege of the user.
Definition KviUserIdentity.h:266
const QString & altNickName2() const
Returns the second alternative nickname of the user.
Definition KviUserIdentity.h:112
QString m_szRealName
Definition KviUserIdentity.h:70
void setAltNickName1(const QString &szNickName)
Sets the alternative nickname of the user.
Definition KviUserIdentity.h:217
QString m_szAge
Definition KviUserIdentity.h:78
QString m_szNickName
Definition KviUserIdentity.h:63
void setLocation(const QString &szLocation)
Sets the location of the user.
Definition KviUserIdentity.h:294
QString m_szOtherInfo
Definition KviUserIdentity.h:82
QString m_szAltNickName2
Definition KviUserIdentity.h:66
const QString & languages() const
Returns the languages of the user.
Definition KviUserIdentity.h:172
~KviUserIdentity()
Destroys the user identity object.
const QString & partMessage() const
Returns the part message of the user.
Definition KviUserIdentity.h:142
void setPassword(const QString &szPassword)
Sets the password of the user.
Definition KviUserIdentity.h:252
void setRealName(const QString &szRealName)
Sets the realname of the user.
Definition KviUserIdentity.h:245
const QString & userMode() const
Returns the user mode of the user.
Definition KviUserIdentity.h:184
const QString & id() const
Returns the id of the user.
Definition KviUserIdentity.h:94
const KviPixmap & avatar() const
Returns the avatar of the user.
Definition KviUserIdentity.h:136
const QString & nickName() const
Returns the nickname of the user.
Definition KviUserIdentity.h:100
QString m_szOnLoginCommand
Definition KviUserIdentity.h:87
KviPixmap m_pixAvatar
Definition KviUserIdentity.h:73
QString m_szUserMode
Definition KviUserIdentity.h:84
void setAvatar(const KviPixmap &pix)
Sets the avatar of the user.
Definition KviUserIdentity.h:259
QString m_szOnConnectCommand
Definition KviUserIdentity.h:86
QString m_szAltNickName1
Definition KviUserIdentity.h:65
void setLanguages(const QString &szLanguages)
Sets the languages of the user.
Definition KviUserIdentity.h:301
void setAltNickName2(const QString &szNickName)
Sets the second alternative nickname of the user.
Definition KviUserIdentity.h:224
const QString & userName() const
Returns the username of the user.
Definition KviUserIdentity.h:124
QString m_szQuitMessage
Definition KviUserIdentity.h:76
QString m_szPartMessage
Definition KviUserIdentity.h:75
void setUserName(const QString &szUserName)
Sets the username of the user.
Definition KviUserIdentity.h:238
const QString & onConnectCommand() const
Returns the list of commands to run on connection.
Definition KviUserIdentity.h:190
QString m_szId
Definition KviUserIdentity.h:61
void setAltNickName3(const QString &szNickName)
Sets the third alternative nickname of the user.
Definition KviUserIdentity.h:231
void setOtherInfo(const QString &szOtherInfo)
Sets the other info for the user.
Definition KviUserIdentity.h:308
const QString & gender() const
Returns the gender of the user.
Definition KviUserIdentity.h:160
void setGender(const QString &szGender)
Sets the gender of the user.
Definition KviUserIdentity.h:287
const QString & onLoginCommand() const
Returns the list of commands to run on login.
Definition KviUserIdentity.h:196
void setOnLoginCommand(const QString &szOnLoginCommand)
Sets the commands list to run on login.
Definition KviUserIdentity.h:329
void setAge(const QString &szAge)
Sets the age of the user.
Definition KviUserIdentity.h:280
QString m_szGender
Definition KviUserIdentity.h:79
void setUserMode(const QString &szUserMode)
Sets the user mode of the user.
Definition KviUserIdentity.h:315
void setQuitMessage(const QString &szMsg)
Sets the quit messaege of the user.
Definition KviUserIdentity.h:273
const QString & otherInfo() const
Returns the other info field of the user.
Definition KviUserIdentity.h:178
QString m_szPassword
Definition KviUserIdentity.h:71
const QString & location() const
Returns the location of the user.
Definition KviUserIdentity.h:166
const QString & password() const
Returns the password of the user.
Definition KviUserIdentity.h:130
QString m_szAltNickName3
Definition KviUserIdentity.h:67
const QString & quitMessage() const
Returns the quit message of the user.
Definition KviUserIdentity.h:148
const QString & altNickName3() const
Returns the third alternative nickanem of the user.
Definition KviUserIdentity.h:118
void setOnConnectCommand(const QString &szOnConnectCommand)
Sets the commands list to run on connection.
Definition KviUserIdentity.h:322
QString m_szLocation
Definition KviUserIdentity.h:80
const QString & age() const
Returns the age of the user.
Definition KviUserIdentity.h:154
void setId(const QString &szId)
Sets the id of the user.
Definition KviUserIdentity.h:203
This file contains compile time settings.
#define KVILIB_API
Definition kvi_settings.h:124