kio Library API Documentation

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>

List of all members.

Public Methods

 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 309 of file kuserprofile.cpp.

KServiceOffer::KServiceOffer const KServiceOffer &   
 

Copy constructor.

Shallow copy (the KService will not be copied).

Definition at line 314 of file kuserprofile.cpp.

References m_bAllowAsDefault, m_iPreference, and m_pService.

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 321 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 329 of file kuserprofile.cpp.

References m_bAllowAsDefault, and m_iPreference.

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:
KDE Logo
This file is part of the documentation for kio Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Apr 22 14:24:19 2004 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2003