• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDECore

KSycocaEntry Class Reference

#include <ksycocaentry.h>

Inheritance diagram for KSycocaEntry:

Inheritance graph
[legend]

List of all members.


Detailed Description

Base class for all Sycoca entries.

You can't create an instance of KSycocaEntry, but it provides the common functionality for servicetypes and services.

Definition at line 41 of file ksycocaentry.h.


Public Types

typedef QList< Ptr > List
typedef KSharedPtr< KSycocaEntry > Ptr

Public Member Functions

QString entryPath () const
bool isDeleted () const
bool isSeparator () const
bool isType (KSycocaType t) const
bool isValid () const
 KSycocaEntry ()
QString name () const
int offset () const
QVariant property (const QString &name) const
QStringList propertyNames () const
void save (QDataStream &s)
void setDeleted (bool deleted)
KSycocaType sycocaType () const
virtual ~KSycocaEntry ()

Static Public Member Functions

static void read (QDataStream &s, QStringList &list)
static void read (QDataStream &s, QString &str)

Protected Member Functions

 KSycocaEntry (KSycocaEntryPrivate &d)

Protected Attributes

KSycocaEntryPrivate * d_ptr

Related Functions

(Note that these are not member functions.)

enum  KSycocaType

Member Typedef Documentation

typedef QList<Ptr> KSycocaEntry::List

Reimplemented in KMimeType, KService, KServiceGroup, KServiceType, and KProtocolInfo.

Definition at line 62 of file ksycocaentry.h.

typedef KSharedPtr<KSycocaEntry> KSycocaEntry::Ptr

Reimplemented in KMimeType, KService, KServiceGroup, KServiceType, and KProtocolInfo.

Definition at line 61 of file ksycocaentry.h.


Constructor & Destructor Documentation

KSycocaEntry::KSycocaEntry (  ) 

Definition at line 30 of file ksycocaentry.cpp.

KSycocaEntry::~KSycocaEntry (  )  [virtual]

Definition at line 40 of file ksycocaentry.cpp.

KSycocaEntry::KSycocaEntry ( KSycocaEntryPrivate &  d  )  [protected]

Definition at line 35 of file ksycocaentry.cpp.


Member Function Documentation

QString KSycocaEntry::entryPath (  )  const

Returns:
the path of this entry The path can be absolute or relative.

The corresponding factory should know relative to what.

Definition at line 103 of file ksycocaentry.cpp.

bool KSycocaEntry::isDeleted (  )  const

Returns:
true if deleted

Definition at line 109 of file ksycocaentry.cpp.

bool KSycocaEntry::isSeparator (  )  const

Definition at line 121 of file ksycocaentry.cpp.

bool KSycocaEntry::isType ( KSycocaType  t  )  const

internal

Definition at line 93 of file ksycocaentry.cpp.

bool KSycocaEntry::isValid (  )  const

Returns:
true if valid

Definition at line 144 of file ksycocaentry.cpp.

QString KSycocaEntry::name (  )  const

Returns:
the name of this entry

Definition at line 150 of file ksycocaentry.cpp.

int KSycocaEntry::offset (  )  const

Definition at line 126 of file ksycocaentry.cpp.

QVariant KSycocaEntry::property ( const QString &  name  )  const

Returns the requested property.

Some often used properties have convenience access functions like exec(), serviceTypes etc.

Parameters:
_name the name of the property
Returns:
the property, or invalid if not found

Definition at line 162 of file ksycocaentry.cpp.

QStringList KSycocaEntry::propertyNames (  )  const

Returns the list of all properties that this service can have.

That means, that some of these properties may be empty.

Returns:
the list of supported properties

Definition at line 156 of file ksycocaentry.cpp.

void KSycocaEntry::read ( QDataStream &  s,
QStringList &  list 
) [static]

Definition at line 70 of file ksycocaentry.cpp.

void KSycocaEntry::read ( QDataStream &  s,
QString &  str 
) [static]

Default constructor.

Safe demarshalling functions.

Definition at line 45 of file ksycocaentry.cpp.

void KSycocaEntry::save ( QDataStream &  s  ) 

Definition at line 138 of file ksycocaentry.cpp.

void KSycocaEntry::setDeleted ( bool  deleted  ) 

Sets whether or not this service is deleted.

Definition at line 115 of file ksycocaentry.cpp.

KSycocaType KSycocaEntry::sycocaType (  )  const

internal

Definition at line 98 of file ksycocaentry.cpp.


Friends And Related Function Documentation

enum KSycocaType [related]

A KSycocaType is a code (out of the KSycocaType enum) assigned to each class type derived from KSycocaEntry .

To use it, call the macro K_SYCOCATYPE( your_typecode, parent_class ) at the top of your class definition.

Definition at line 31 of file ksycocatype.h.


Member Data Documentation

KSycocaEntryPrivate* KSycocaEntry::d_ptr [protected]

Definition at line 143 of file ksycocaentry.h.


The documentation for this class was generated from the following files:
  • ksycocaentry.h
  • ksycocatype.h
  • ksycocaentry.cpp

KDECore

Skip menu "KDECore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • KIO
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal