# kio Library API Documentation

Overview | Class Hierarchy | Classes | Classes (annotated) | Members | Namespaces | Source Files

# KServiceOffer Class Reference

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. More...

`#include <kuserprofile.h>`

Collaboration diagram for KServiceOffer:

[legend]
List of all members.

## Public Member Functions

| KServiceOffer ()
| KServiceOffer (const KServiceOffer &)
| KServiceOffer (KService::Ptr _service, int _pref, bool _default)
bool | operator< (const KServiceOffer &) const
bool | allowAsDefault () const
int | preference () const
KService::Ptr | service () const
bool | isValid () const

## Detailed Description

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 KService, a number that represents the user's preference (bigger is better) and a flag whether the KService can be used as default.

See also:
  KService

Definition at line 40 of file kuserprofile.h.

## Constructor & Destructor Documentation

KServiceOffer::KServiceOffer | ( |  | ) |

| Create an invalid service offer. Definition at line 313 of file kuserprofile.cpp.

KServiceOffer::KServiceOffer | ( | const KServiceOffer & |  | ) |

| Copy constructor. Shallow copy (the KService will not be copied). Definition at line 318 of file kuserprofile.cpp.

KServiceOffer::KServiceOffer | ( | KService::Ptr | _service,
|  | int | _pref,
|  | bool | _default
| ) |

Creates a new KServiceOffer.

Parameters:

  | _service | a pointer to the KService
  | _pref | the user's preference value, must be positive, bigger is better
  | _default | true if the service should be used as default

Definition at line 325 of file kuserprofile.cpp.

## Member Function Documentation

bool KServiceOffer::operator< | ( | const KServiceOffer & |  | ) | const

| A service is bigger that the other when it can be default (and the other is not) and its preference value it higher. Definition at line 333 of file kuserprofile.cpp.

bool KServiceOffer::allowAsDefault | ( |  | ) | const`[inline]`

Is it allowed to use this service for default actions (e.g.

Left Click in a file manager, or KRun in general).

Returns:
  true if the service is a allowed as default

Definition at line 75 of file kuserprofile.h.

int KServiceOffer::preference | ( |  | ) | const`[inline]`

The bigger this number is, the better is this service.

Returns:
  the preference number (negative numbers will be returned by invalid service offers)

Definition at line 81 of file kuserprofile.h.

KService::Ptr KServiceOffer::service | ( |  | ) | const`[inline]`

The service which this offer is about.

Returns:
  the service this offer is about, can be 0 in valid offers or when not set

Definition at line 87 of file kuserprofile.h.

bool KServiceOffer::isValid | ( |  | ) | const`[inline]`

Check whether the entry is valid.

A service is valid if its preference value is positive.

Returns:
  true if the service offer is valid

Definition at line 93 of file kuserprofile.h.

The documentation for this class was generated from the following files:

- kuserprofile.h
- kuserprofile.cpp

This file is part of the documentation for kio Library Version 3.4.1.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat Jun 11 20:25:17 2005 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003