KDECore
KUserGroup Class Reference
#include <KUserGroup>
Detailed Description
Represents a group on your system.This class represents a group on your system. You can either get information about the group of the current user, of fetch information about a group 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.
Definition at line 260 of file kuser.h.
Public Member Functions | |
K_GID | gid () const |
bool | isValid () const |
KUserGroup (const KUserGroup &group) | |
KUserGroup (const group *g) | |
KUserGroup (K_GID gid) | |
KUserGroup (KUser::UIDMode mode=KUser::UseEffectiveUID) | |
KUserGroup (const char *name) | |
KUserGroup (const QString &name) | |
QString | name () const |
bool | operator!= (const KUserGroup &group) const |
KUserGroup & | operator= (const KUserGroup &group) |
bool | operator== (const KUserGroup &group) const |
QStringList | userNames () const |
QList< KUser > | users () const |
~KUserGroup () | |
Static Public Member Functions | |
static QStringList | allGroupNames () |
static QList< KUserGroup > | allGroups () |
Constructor & Destructor Documentation
KUserGroup::KUserGroup | ( | const QString & | name | ) | [explicit] |
Create an object from a group name.
If the group does not exist, isValid() will return false.
- Parameters:
-
name the name of the group
Definition at line 269 of file kuser_unix.cpp.
KUserGroup::KUserGroup | ( | const char * | name | ) | [explicit] |
Create an object from a group name.
If the group does not exist, isValid() will return false.
- Parameters:
-
name the name of the group
Definition at line 274 of file kuser_unix.cpp.
KUserGroup::KUserGroup | ( | KUser::UIDMode | mode = KUser::UseEffectiveUID |
) | [explicit] |
Create an object from the group of the current user.
- Parameters:
-
mode if KUser::UseEffectiveUID is passed the effective user will be used. If KUser::UseRealUserID is passed the real user will be used. 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 group associated with the user.
Definition at line 259 of file kuser_unix.cpp.
KUserGroup::KUserGroup | ( | K_GID | gid | ) | [explicit] |
Create an object from a group id.
If the group does not exist, isValid() will return false.
- Parameters:
-
gid the group id
Definition at line 264 of file kuser_unix.cpp.
KUserGroup::KUserGroup | ( | const group * | g | ) | [explicit] |
Creates an object from a group structure.
If the pointer is null, isValid() will return false.
- Parameters:
-
g the group structure to create the group from.
KUserGroup::KUserGroup | ( | const KUserGroup & | group | ) |
Creates a new KUserGroup instance from another KUserGroup object.
- Parameters:
-
group the KUserGroup to copy
Definition at line 284 of file kuser_unix.cpp.
KUserGroup::~KUserGroup | ( | ) |
Member Function Documentation
QStringList KUserGroup::allGroupNames | ( | ) | [static] |
QList< KUserGroup > KUserGroup::allGroups | ( | ) | [static] |
K_GID KUserGroup::gid | ( | ) | const |
Returns the group id of the group.
- Returns:
- the group id of the group or -1 if the group is invalid
Definition at line 306 of file kuser_unix.cpp.
bool KUserGroup::isValid | ( | ) | const |
Returns whether the group is valid.
A KUserGroup object can be invalid if it is created with a non-existing gid or name.
- Returns:
- true if the group is valid
Definition at line 302 of file kuser_unix.cpp.
QString KUserGroup::name | ( | ) | const |
bool KUserGroup::operator!= | ( | const KUserGroup & | group | ) | const |
Two KUserGroup objects are not equal if their gid()s are not identical.
Invalid groups always compare unequal.
- Returns:
- true if the groups are not identical
Definition at line 298 of file kuser_unix.cpp.
KUserGroup & KUserGroup::operator= | ( | const KUserGroup & | group | ) |
Copies a group.
- Parameters:
-
group the group that should be copied
- Returns:
- this group
Definition at line 289 of file kuser_unix.cpp.
bool KUserGroup::operator== | ( | const KUserGroup & | group | ) | const |
Two KUserGroup objects are equal if their gid()s are identical.
Invalid groups never compare equal.
- Returns:
- true if the groups are identical
Definition at line 294 of file kuser_unix.cpp.
QStringList KUserGroup::userNames | ( | ) | const |
Returns a list of all user login names of the group.
- Returns:
- a list of all user login names of the group
Definition at line 318 of file kuser_unix.cpp.
Returns a list of all users of the group.
- Returns:
- a list of all users of the group
Definition at line 314 of file kuser_unix.cpp.
The documentation for this class was generated from the following files: