KUser Class Reference

Represents a user on your system. More...

#include <kuser.h>

List of all members.

Public Types
enum	UIDMode { UseEffectiveUID, UseRealUserID }
Public Member Functions
QString	fullName () const
long	gid () const
QStringList	groupNames () const
QValueList< KUserGroup >	groups () const
QString	homeDir () const
QString	homePhone () const
bool	isSuperUser () const
bool	isValid () const
	KUser (const KUser &user)
	KUser (struct passwd *p)
	KUser (const char *name)
	KUser (const QString &name)
	KUser (long uid)
	KUser (UIDMode mode=UseEffectiveUID)
QString	loginName () const
bool	operator!= (const KUser &user) const
KUser &	operator= (const KUser &user)
bool	operator== (const KUser &user) const
QString	roomNumber () const
QString	shell () const
long	uid () const
QString	workPhone () const
	~KUser ()
Static Public Member Functions
static QStringList	allUserNames ()
static QValueList< KUser >	allUsers ()

---

Detailed Description

Represents a user on your system.

This class represents a user on your system. You can either get information about the current user, of fetch information about a user on the system. Instances of this class will be explicitly shared, so copying objects is very cheap and you can safely pass objects by value.

Author:

Tim Jansen <tim@tjansen.de>

Since:

3.2

Definition at line 45 of file kuser.h.

---

Member Enumeration Documentation

enum KUser::UIDMode

Enumerator:

UseEffectiveUID	Use the effective user id.
UseRealUserID	Use the real user id.

Definition at line 49 of file kuser.h.

---

Constructor & Destructor Documentation

KUser::KUser

(

UIDMode

mode = UseEffectiveUID

)

Creates an object that contains information about the current user.

(as returned by getuid(2) or geteuid(2), taking $LOGNAME/$USER into account).

Parameters:

mode

if UseEffectiveUID is passed the effective user is returned. If UseRealUserID is passed the real user will be returned. The real UID will be different than the effective UID in setuid programs; in such a case use the effective UID for checking permissions, and the real UID for displaying information about the user.

Definition at line 68 of file kuser.cpp.

KUser::KUser

(

long

uid

)

Creates an object for the user with the given user id.

If the user does not exist isValid() will return false.

Parameters:

uid

the user id

Definition at line 82 of file kuser.cpp.

KUser::KUser

(

const QString &

name

)

Creates an object that contains information about the user with the given name.

If the user does not exist isValid() will return false.

Parameters:

name

the name of the user

Definition at line 86 of file kuser.cpp.

KUser::KUser

(

const char *

name

)

Creates an object that contains information about the user with the given name.

If the user does not exist isValid() will return false.

Parameters:

name

the name of the user

Definition at line 90 of file kuser.cpp.

KUser::KUser

(

struct passwd *

p

)

Creates an object from a passwd structure.

If the pointer is null isValid() will return false.

Parameters:

p

the passwd structure to create the user from

Definition at line 94 of file kuser.cpp.

KUser::KUser

(

const KUser &

user

)

Creates an object from another KUser object.

Parameters:

user

the user to create the new object from

Definition at line 98 of file kuser.cpp.

KUser::~KUser

(

)

Destructor.

Definition at line 271 of file kuser.cpp.

---

Member Function Documentation

QStringList KUser::allUserNames

(

)

[static]

Returns all user names of the system.

Returns:

all user names of the system.

Definition at line 257 of file kuser.cpp.

QValueList< KUser > KUser::allUsers

(

)

[static]

Returns all users of the system.

Returns:

all users of the system.

Definition at line 243 of file kuser.cpp.

QString KUser::fullName

(

)

const

The full name of the user.

Returns:

the full name of the user or QString::null if user is invalid

Definition at line 174 of file kuser.cpp.

long KUser::gid

(

)

const

Returns the group id of the user.

Returns:

the id of the group or -1 if user is invalid

Definition at line 156 of file kuser.cpp.

QStringList KUser::groupNames

(

)

const

Returns all group names of the user.

Returns:

all group names of the user

Definition at line 229 of file kuser.cpp.

QValueList< KUserGroup > KUser::groups

(

)

const

Returns all groups of the user.

Returns:

all groups of the user

Definition at line 216 of file kuser.cpp.

QString KUser::homeDir

(

)

const

The path to the user's home directory.

Returns:

the home directory of the user or QString::null if the user is invalid

Definition at line 202 of file kuser.cpp.

QString KUser::homePhone

(

)

const

The user's home phone.

Returns:

the home phone of the user or QString::null if not set or the user is invalid

Definition at line 195 of file kuser.cpp.

bool KUser::isSuperUser

(

)

const

Checks whether the user it the super user (root).

Returns:

true if the user is root

Definition at line 163 of file kuser.cpp.

bool KUser::isValid

(

)

const

Returns true if the user is valid.

A KUser object can be invalid if you created it with an non-existing uid or name.

Returns:

true if the user is valid

Definition at line 145 of file kuser.cpp.

QString KUser::loginName

(

)

const

The login name of the user.

Returns:

the login name of the user or QString::null if user is invalid

Definition at line 167 of file kuser.cpp.

bool KUser::operator!=

(

const KUser &

user

)

const

Two KUser objects are not equal if either isValid() is not true or uid() are not identical.

Definition at line 118 of file kuser.cpp.

KUser & KUser::operator=

(

const KUser &

user

)

Copies a user.

Parameters:

user

the user to copy

Returns:

this object

Definition at line 103 of file kuser.cpp.

bool KUser::operator==

(

const KUser &

user

)

const

Two KUser objects are equal if isValid() is true and the uid() are identical.

Definition at line 109 of file kuser.cpp.

QString KUser::roomNumber

(

)

const

The user's room number.

Returns:

the room number of the user or QString::null if not set or the user is invalid

Definition at line 181 of file kuser.cpp.

QString KUser::shell

(

)

const

The path to the user's login shell.

Returns:

the login shell of the user or QString::null if the user is invalid

Definition at line 209 of file kuser.cpp.

long KUser::uid

(

)

const

Returns the user id of the user.

Returns:

the id of the user or -1 if user is invalid

Definition at line 149 of file kuser.cpp.

QString KUser::workPhone

(

)

const

The user's work phone.

Returns:

the work phone of the user or QString::null if not set or the user is invalid

Definition at line 188 of file kuser.cpp.

---

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

• kuser.h
• kuser.cpp