.TH "KUserGroup" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KUserGroup \- Represents a group on your system.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kuser.h>\fP
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKUserGroup\fP (\fBKUser::UIDMode\fP mode=KUser::UseEffectiveUID)"
.br
.ti -1c
.RI "\fBKUserGroup\fP (long gid)"
.br
.ti -1c
.RI "\fBKUserGroup\fP (const \fBQString\fP &name)"
.br
.ti -1c
.RI "\fBKUserGroup\fP (const char *name)"
.br
.ti -1c
.RI "\fBKUserGroup\fP (struct group *g)"
.br
.ti -1c
.RI "\fBKUserGroup\fP (const \fBKUserGroup\fP &group)"
.br
.ti -1c
.RI "\fBKUserGroup\fP & \fBoperator=\fP (const \fBKUserGroup\fP &group)"
.br
.ti -1c
.RI "bool \fBoperator==\fP (const \fBKUserGroup\fP &group) const "
.br
.ti -1c
.RI "bool \fBoperator!=\fP (const \fBKUserGroup\fP &group) const "
.br
.ti -1c
.RI "bool \fBisValid\fP () const "
.br
.ti -1c
.RI "long \fBgid\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBname\fP () const "
.br
.ti -1c
.RI "const \fBQValueList\fP< \fBKUser\fP > & \fBusers\fP () const "
.br
.ti -1c
.RI "\fBQStringList\fP \fBuserNames\fP () const "
.br
.ti -1c
.RI "\fB~KUserGroup\fP ()"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBQValueList\fP< \fBKUserGroup\fP > \fBallGroups\fP ()"
.br
.ti -1c
.RI "static \fBQStringList\fP \fBallGroupNames\fP ()"
.br
.in -1c
.SH "Detailed Description"
.PP 
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.
.PP
\fBAuthor:\fP
.RS 4
Jan Schaefer <j_schaef@informatik.uni-kl.de> 
.RE
.PP
\fBSince:\fP
.RS 4
3.3 
.RE
.PP

.PP
Definition at line 256 of file kuser.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KUserGroup::KUserGroup (\fBKUser::UIDMode\fP mode = \fCKUser::UseEffectiveUID\fP)\fC [explicit]\fP"
.PP
Create an object from the group of the current user. 
.PP
\fBParameters:\fP
.RS 4
\fImode\fP if \fBKUser::UseEffectiveUID\fP is passed the effective user will be used. If \fBKUser::UseRealUserID\fP 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. 
.RE
.PP

.PP
Definition at line 293 of file kuser.cpp.
.PP
References KUser< T >::gid().
.PP
Referenced by allGroups().
.SS "KUserGroup::KUserGroup (long gid)\fC [explicit]\fP"
.PP
Create an object from a group id. 
.PP
If the group does not exist, \fBisValid()\fP will return false. 
.PP
\fBParameters:\fP
.RS 4
\fIgid\fP the group id 
.RE
.PP

.PP
Definition at line 298 of file kuser.cpp.
.SS "KUserGroup::KUserGroup (const \fBQString\fP & name)\fC [explicit]\fP"
.PP
Create an object from a group name. 
.PP
If the group does not exist, \fBisValid()\fP will return false. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP the name of the group 
.RE
.PP

.PP
Definition at line 302 of file kuser.cpp.
.PP
References QString::local8Bit(), and name().
.SS "KUserGroup::KUserGroup (const char * name)\fC [explicit]\fP"
.PP
Create an object from a group name. 
.PP
If the group does not exist, \fBisValid()\fP will return false. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP the name of the group 
.RE
.PP

.PP
Definition at line 306 of file kuser.cpp.
.PP
References name().
.SS "KUserGroup::KUserGroup (struct group * g)\fC [explicit]\fP"
.PP
Creates an object from a group structure. 
.PP
If the pointer is null, \fBisValid()\fP will return false. 
.PP
\fBParameters:\fP
.RS 4
\fIg\fP the group structure to create the group from. 
.RE
.PP

.PP
Definition at line 310 of file kuser.cpp.
.SS "KUserGroup::KUserGroup (const \fBKUserGroup\fP & group)"
.PP
Creates a new KUserGroup instance from another KUserGroup object. 
.PP
\fBParameters:\fP
.RS 4
\fIgroup\fP the KUserGroup to copy 
.RE
.PP

.PP
Definition at line 315 of file kuser.cpp.
.SS "KUserGroup::~\fBKUserGroup\fP ()"
.PP
Destructor. 
.PP
Definition at line 423 of file kuser.cpp.
.SH "Member Function Documentation"
.PP 
.SS "\fBKUserGroup\fP & KUserGroup::operator= (const \fBKUserGroup\fP & group)"
.PP
Copies a group. 
.PP
\fBParameters:\fP
.RS 4
\fIgroup\fP the group that should be copied 
.RE
.PP
\fBReturns:\fP
.RS 4
this group 
.RE
.PP

.PP
Definition at line 320 of file kuser.cpp.
.SS "bool KUserGroup::operator== (const \fBKUserGroup\fP & group) const"
.PP
Two KUserGroup objects are equal if \fBisValid()\fP is true and \fBgid()\fP are identical. 
.PP
\fBReturns:\fP
.RS 4
true if the groups are identical 
.RE
.PP

.PP
Definition at line 325 of file kuser.cpp.
.PP
References gid(), and isValid().
.PP
Referenced by operator!=().
.SS "bool KUserGroup::operator!= (const \fBKUserGroup\fP & group) const"
.PP
Two KUserGroup objects are not equal if either \fBisValid()\fP is not true or \fBgid()\fP are not identical. 
.PP
\fBReturns:\fP
.RS 4
true if the groups are not identical 
.RE
.PP

.PP
Definition at line 334 of file kuser.cpp.
.PP
References operator==().
.SS "bool KUserGroup::isValid () const"
.PP
Returns wether the group is valid. 
.PP
A KUserGroup object can be invalid if it is created with a non-existing gid or name. 
.PP
\fBReturns:\fP
.RS 4
true if the group is valid 
.RE
.PP

.PP
Definition at line 363 of file kuser.cpp.
.PP
Referenced by operator==().
.SS "long KUserGroup::gid () const"
.PP
Returns the group id of the group. 
.PP
\fBReturns:\fP
.RS 4
the group id of the group or -1 if the group is invalid 
.RE
.PP

.PP
Definition at line 367 of file kuser.cpp.
.PP
Referenced by operator==().
.SS "\fBQString\fP KUserGroup::name () const"
.PP
The name of the group. 
.PP
\fBReturns:\fP
.RS 4
the name of the group 
.RE
.PP

.PP
Definition at line 374 of file kuser.cpp.
.PP
Referenced by KUserGroup().
.SS "const \fBQValueList\fP< \fBKUser\fP > & KUserGroup::users () const"
.PP
Returns a list of all users of the group. 
.PP
\fBReturns:\fP
.RS 4
a list of all users of the group 
.RE
.PP

.PP
Definition at line 381 of file kuser.cpp.
.SS "\fBQStringList\fP KUserGroup::userNames () const"
.PP
Returns a list of all user login names of the group. 
.PP
\fBReturns:\fP
.RS 4
a list of all user login names of the group 
.RE
.PP

.PP
Definition at line 385 of file kuser.cpp.
.SS "\fBQValueList\fP< \fBKUserGroup\fP > KUserGroup::allGroups ()\fC [static]\fP"
.PP
Returns a list of all groups on this system. 
.PP
Definition at line 396 of file kuser.cpp.
.PP
References QValueList::append(), and KUserGroup().
.PP
Referenced by KUser< T >::groupNames(), and KUser< T >::groups().
.SS "\fBQStringList\fP KUserGroup::allGroupNames ()\fC [static]\fP"
.PP
Returns a list of all group names on this system. 
.PP
Definition at line 409 of file kuser.cpp.

.SH "Author"
.PP 
Generated automatically by Doxygen for kdecore Library from the source code.
