#include <KUserGroup>
Public Member Functions | |
| KUserGroup (const QString &name) | |
| KUserGroup (const char *name) | |
| KUserGroup (KGroupId gid) | |
| KUserGroup (KUser::UIDMode mode=KUser::UseEffectiveUID) | |
| KUserGroup (K_GID gid) | |
| KUserGroup (const group *g) | |
| KUserGroup (const KUserGroup &group) | |
| ~KUserGroup () | |
| K_GID | gid () const |
| KGroupId | groupId () const |
| bool | isValid () const |
| QString | name () const |
| bool | operator!= (const KUserGroup &group) const |
| KUserGroup & | operator= (const KUserGroup &group) |
| bool | operator== (const KUserGroup &group) const |
| QStringList | userNames (uint maxCount=KCOREADDONS_UINT_MAX) const |
| QList< KUser > | users (uint maxCount=KCOREADDONS_UINT_MAX) const |
Static Public Member Functions | |
| static QStringList | allGroupNames (uint maxCount=KCOREADDONS_UINT_MAX) |
| static QList< KUserGroup > | allGroups (uint maxCount=KCOREADDONS_UINT_MAX) |
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.
Constructor & Destructor Documentation
|
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 378 of file kuser_unix.cpp.
|
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 383 of file kuser_unix.cpp.
|
explicit |
Creates an object for the group with the given group id.
If the KGroupId object is invalid this one will be, too.
- Parameters
-
gid the group id
Definition at line 373 of file kuser_unix.cpp.
|
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 363 of file kuser_unix.cpp.
|
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 368 of file kuser_unix.cpp.
|
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 393 of file kuser_unix.cpp.
| KUserGroup::~KUserGroup | ( | ) |
Destructor.
Definition at line 512 of file kuser_unix.cpp.
Member Function Documentation
|
static |
- Parameters
-
maxCount the maximum number of groups to return
- Returns
- a list of all group names on this system
Definition at line 496 of file kuser_unix.cpp.
|
static |
- Parameters
-
maxCount the maximum number of groups to return
- Returns
- a list of all groups on this system
Definition at line 480 of file kuser_unix.cpp.
|
inline |
Returns the group id of the group.
- Returns
- the group id of the group or -1 if the group is invalid
- Deprecated:
- since 5.0 use KUserGroup::groupId()
| KGroupId KUserGroup::groupId | ( | ) | const |
- Returns
- the native group id of the user.
Definition at line 414 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 409 of file kuser_unix.cpp.
| QString KUserGroup::name | ( | ) | const |
|
inline |
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
| KUserGroup & KUserGroup::operator= | ( | const KUserGroup & | group | ) |
Copies a group.
- Parameters
-
group the group that should be copied
- Returns
- this group
Definition at line 398 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 404 of file kuser_unix.cpp.
| QStringList KUserGroup::userNames | ( | uint | maxCount = KCOREADDONS_UINT_MAX | ) | const |
- Parameters
-
maxCount the maximum number of groups to return
- Returns
- a list of all user login names of the group
Definition at line 471 of file kuser_unix.cpp.
- Parameters
-
maxCount the maximum number of users to return
- Returns
- a list of all users of the group
Definition at line 462 of file kuser_unix.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2020 The KDE developers.
Generated on Tue Jan 28 2020 03:59:24 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.