KDECore
#include <KUser>
Public Types | |
enum | UIDMode { UseEffectiveUID , UseRealUserID } |
enum | UserProperty { FullName , RoomNumber , WorkPhone , HomePhone } |
Public Member Functions | |
KUser (const char *name) | |
KUser (const KUser &user) | |
KUser (const QString &name) | |
KUser (K_UID uid) | |
KUser (UIDMode mode=UseEffectiveUID) | |
~KUser () | |
QString | faceIconPath () const |
QString | fullName () const |
QStringList | groupNames () const |
QList< KUserGroup > | groups () const |
QString | homeDir () const |
bool | isSuperUser () const |
bool | isValid () const |
QString | loginName () const |
bool | operator!= (const KUser &user) const |
KUser & | operator= (const KUser &user) |
bool | operator== (const KUser &user) const |
QVariant | property (UserProperty which) const |
QString | shell () const |
K_UID | uid () const |
Static Public Member Functions | |
static QStringList | allUserNames () |
static QList< 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.
Member Enumeration Documentation
◆ UIDMode
enum KUser::UIDMode |
◆ UserProperty
enum KUser::UserProperty |
Constructor & Destructor Documentation
◆ KUser() [1/5]
|
explicit |
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 74 of file kuser_unix.cpp.
◆ KUser() [2/5]
|
explicit |
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 89 of file kuser_unix.cpp.
◆ KUser() [3/5]
|
explicit |
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 94 of file kuser_unix.cpp.
◆ KUser() [4/5]
|
explicit |
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 99 of file kuser_unix.cpp.
◆ KUser() [5/5]
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 109 of file kuser_unix.cpp.
◆ ~KUser()
KUser::~KUser | ( | ) |
Destructor.
Definition at line 231 of file kuser_unix.cpp.
Member Function Documentation
◆ allUserNames()
|
static |
Returns all user names of the system.
- Returns
- all user names of the system.
Definition at line 218 of file kuser_unix.cpp.
◆ allUsers()
Returns all users of the system.
- Returns
- all users of the system.
Definition at line 204 of file kuser_unix.cpp.
◆ faceIconPath()
QString KUser::faceIconPath | ( | ) | const |
The path to the user's face file.
- Returns
- the path to the user's face file or QString() if no face has been set
Definition at line 158 of file kuser_unix.cpp.
◆ fullName()
QString KUser::fullName | ( | ) | const |
The full name of the user.
- Returns
- the full name of the user or QString() if user is invalid
- Deprecated:
- use property(KUser::FullName) instead
Definition at line 149 of file kuser_unix.cpp.
◆ groupNames()
QStringList KUser::groupNames | ( | ) | const |
Returns all group names of the user.
- Returns
- all group names of the user
Definition at line 186 of file kuser_unix.cpp.
◆ groups()
QList< KUserGroup > KUser::groups | ( | ) | const |
Returns all groups of the user.
- Returns
- all groups of the user
Definition at line 173 of file kuser_unix.cpp.
◆ homeDir()
QString KUser::homeDir | ( | ) | const |
The path to the user's home directory.
- Returns
- the home directory of the user or QString() if the user is invalid
Definition at line 154 of file kuser_unix.cpp.
◆ isSuperUser()
bool KUser::isSuperUser | ( | ) | const |
Checks whether the user is the super user (root).
- Returns
- true if the user is root
Definition at line 140 of file kuser_unix.cpp.
◆ isValid()
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 128 of file kuser_unix.cpp.
◆ loginName()
QString KUser::loginName | ( | ) | const |
The login name of the user.
- Returns
- the login name of the user or QString() if user is invalid
Definition at line 144 of file kuser_unix.cpp.
◆ operator!=()
Two KUser objects are not equal if uid() are not identical.
Invalid users always compare unequal.
Definition at line 124 of file kuser_unix.cpp.
◆ operator=()
Copies a user.
- Parameters
-
user the user to copy
- Returns
- this object
Definition at line 114 of file kuser_unix.cpp.
◆ operator==()
Two KUser objects are equal if the uid() are identical.
Invalid users never compare equal.
Definition at line 120 of file kuser_unix.cpp.
◆ property()
QVariant KUser::property | ( | UserProperty | which | ) | const |
Returns an extended property.
Under Windows, RoomNumber
, WorkPhone
and HomePhone
are unsupported.
- Returns
- a QVariant with the value of the property or an invalid QVariant, if the property is not set
Definition at line 199 of file kuser_unix.cpp.
◆ shell()
QString KUser::shell | ( | ) | const |
The path to the user's login shell.
- Returns
- the login shell of the user or QString() if the user is invalid
Definition at line 169 of file kuser_unix.cpp.
◆ uid()
K_UID 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 132 of file kuser_unix.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.