.TH "KServiceOffer" kde3 "11 Jun 2005" "Version Version 3.4.1" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KServiceOffer \- This class holds the user-specific preferences of a service (whether it can be a default offer or not, how big is the preference for this offer, ...). Holds the user's preference of a service.  

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

.in +1c
.ti -1c
.RI "\fBKServiceOffer\fP ()"
.br
.ti -1c
.RI "\fBKServiceOffer\fP (const \fBKServiceOffer\fP &)"
.br
.ti -1c
.RI "\fBKServiceOffer\fP (\fBKService::Ptr\fP _service, int _pref, bool _default)"
.br
.ti -1c
.RI "bool \fBoperator<\fP (const \fBKServiceOffer\fP &) const "
.br
.ti -1c
.RI "bool \fBallowAsDefault\fP () const "
.br
.ti -1c
.RI "int \fBpreference\fP () const "
.br
.ti -1c
.RI "\fBKService::Ptr\fP \fBservice\fP () const "
.br
.ti -1c
.RI "bool \fBisValid\fP () const "
.br
.in -1c
.SH "Detailed Description"
.PP 
This class holds the user-specific preferences of a service (whether it can be a default offer or not, how big is the preference for this offer, ...). Holds the user's preference of a service. 

Basically it is a reference to a \fBKService\fP, a number that represents the user's preference (bigger is better) and a flag whether the \fBKService\fP can be used as default.
.PP
\fBSee also:\fP
.RS 4
\fBKService\fP 
.RE
.PP

.PP
Definition at line 40 of file kuserprofile.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KServiceOffer::KServiceOffer ()"
.PP
Create an invalid service offer. 
.PP
Definition at line 313 of file kuserprofile.cpp.
.SS "KServiceOffer::KServiceOffer (const \fBKServiceOffer\fP &)"
.PP
Copy constructor. 
.PP
Shallow copy (the \fBKService\fP will not be copied). 
.PP
Definition at line 318 of file kuserprofile.cpp.
.SS "KServiceOffer::KServiceOffer (\fBKService::Ptr\fP _service, int _pref, bool _default)"
.PP
Creates a new KServiceOffer. 
.PP
\fBParameters:\fP
.RS 4
\fI_service\fP a pointer to the \fBKService\fP 
.br
\fI_pref\fP the user's preference value, must be positive, bigger is better 
.br
\fI_default\fP true if the service should be used as default 
.RE
.PP

.PP
Definition at line 325 of file kuserprofile.cpp.
.SH "Member Function Documentation"
.PP 
.SS "bool KServiceOffer::operator< (const \fBKServiceOffer\fP &) const"
.PP
A service is bigger that the other when it can be default (and the other is not) and its preference value it higher. 
.PP
Definition at line 333 of file kuserprofile.cpp.
.SS "bool KServiceOffer::allowAsDefault () const\fC [inline]\fP"
.PP
Is it allowed to use this service for default actions (e.g. 
.PP
Left Click in a file manager, or \fBKRun\fP in general). 
.PP
\fBReturns:\fP
.RS 4
true if the service is a allowed as default 
.RE
.PP

.PP
Definition at line 75 of file kuserprofile.h.
.SS "int KServiceOffer::preference () const\fC [inline]\fP"
.PP
The bigger this number is, the better is this service. 
.PP
\fBReturns:\fP
.RS 4
the preference number (negative numbers will be returned by invalid service offers) 
.RE
.PP

.PP
Definition at line 81 of file kuserprofile.h.
.SS "\fBKService::Ptr\fP KServiceOffer::service () const\fC [inline]\fP"
.PP
The service which this offer is about. 
.PP
\fBReturns:\fP
.RS 4
the service this offer is about, can be 0 in valid offers or when not set 
.RE
.PP

.PP
Definition at line 87 of file kuserprofile.h.
.SS "bool KServiceOffer::isValid () const\fC [inline]\fP"
.PP
Check whether the entry is valid. 
.PP
A service is valid if its preference value is positive. 
.PP
\fBReturns:\fP
.RS 4
true if the service offer is valid 
.RE
.PP

.PP
Definition at line 93 of file kuserprofile.h.

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