KDECore
#include <KUserGroup>
Public Member Functions | |
KUserGroup (const char *name) | |
KUserGroup (const KUserGroup &group) | |
KUserGroup (const QString &name) | |
~KUserGroup () | |
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 () const |
QList< KUser > | users () const |
Static Public Member Functions | |
static QStringList | allGroupNames () |
static QList< KUserGroup > | allGroups () |
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
◆ KUserGroup() [1/3]
|
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 271 of file kuser_unix.cpp.
◆ KUserGroup() [2/3]
|
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 276 of file kuser_unix.cpp.
◆ KUserGroup() [3/3]
KUserGroup::KUserGroup | ( | const KUserGroup & | group | ) |
Creates a new KUserGroup instance from another KUserGroup object.
- Parameters
-
group the KUserGroup to copy
Definition at line 286 of file kuser_unix.cpp.
◆ ~KUserGroup()
KUserGroup::~KUserGroup | ( | ) |
Destructor.
Definition at line 355 of file kuser_unix.cpp.
Member Function Documentation
◆ allGroupNames()
|
static |
Returns a list of all group names on this system.
Definition at line 342 of file kuser_unix.cpp.
◆ allGroups()
|
static |
Returns a list of all groups on this system.
Definition at line 329 of file kuser_unix.cpp.
◆ isValid()
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 304 of file kuser_unix.cpp.
◆ name()
QString KUserGroup::name | ( | ) | const |
◆ operator!=()
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 300 of file kuser_unix.cpp.
◆ operator=()
KUserGroup & KUserGroup::operator= | ( | const KUserGroup & | group | ) |
Copies a group.
- Parameters
-
group the group that should be copied
- Returns
- this group
Definition at line 291 of file kuser_unix.cpp.
◆ operator==()
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 296 of file kuser_unix.cpp.
◆ userNames()
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 320 of file kuser_unix.cpp.
◆ users()
Returns a list of all users of the group.
- Returns
- a list of all users of the group
Definition at line 316 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.