.TH "KSycocaEntry" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KSycocaEntry \- Base class for all Sycoca entries.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <ksycocaentry.h>\fP
.PP
Inherits \fBKShared\fP.
.PP
Inherited by \fBKProtocolInfo\fP, \fBKService\fP, \fBKServiceGroup\fP, and \fBKServiceType\fP.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "typedef \fBKSharedPtr\fP< \fBKSycocaEntry\fP > \fBPtr\fP"
.br
.ti -1c
.RI "typedef \fBQValueList\fP< \fBPtr\fP > \fBList\fP"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual bool \fBisType\fP (\fBKSycocaType\fP t) const "
.br
.ti -1c
.RI "virtual \fBKSycocaType\fP \fBsycocaType\fP () const "
.br
.ti -1c
.RI "\fBKSycocaEntry\fP (const \fBQString\fP &path)"
.br
.ti -1c
.RI "\fBKSycocaEntry\fP (\fBQDataStream\fP &_str, int offset)"
.br
.ti -1c
.RI "virtual \fBQString\fP \fBname\fP () const =0"
.br
.ti -1c
.RI "\fBQString\fP \fBentryPath\fP () const "
.br
.ti -1c
.RI "virtual bool \fBisValid\fP () const =0"
.br
.ti -1c
.RI "virtual bool \fBisDeleted\fP () const "
.br
.ti -1c
.RI "int \fBoffset\fP ()"
.br
.ti -1c
.RI "virtual void \fBsave\fP (\fBQDataStream\fP &s)"
.br
.ti -1c
.RI "virtual void \fBload\fP (\fBQDataStream\fP &)=0"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static void \fBread\fP (\fBQDataStream\fP &s, \fBQString\fP &str)"
.br
.ti -1c
.RI "static void \fBread\fP (\fBQDataStream\fP &s, \fBQStringList\fP &list)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "bool \fBm_bDeleted\fP"
.br
.ti -1c
.RI "\fBQString\fP \fBmPath\fP"
.br
.in -1c
.SS "Related Functions"
(Note that these are not member functions.) 
.in +1c
.ti -1c
.RI "enum \fBKSycocaType\fP { \fBKST_KSycocaEntry\fP =  0, \fBKST_KService\fP =  1, \fBKST_KServiceType\fP =  2, \fBKST_KMimeType\fP =  3, \fBKST_KFolderType\fP =  4, \fBKST_KDEDesktopMimeType\fP =  5, \fBKST_KExecMimeType\fP =  6, \fBKST_KServiceGroup\fP =  7, \fBKST_KImageIOFormat\fP =  8, \fBKST_KProtocolInfo\fP =  9, \fBKST_KServiceSeparator\fP =  10, \fBKST_KCustom\fP =  1000 }"
.br
.in -1c
.SH "Detailed Description"
.PP 
Base class for all Sycoca entries. 

You can't create an instance of KSycocaEntry, but it provides the common functionality for servicetypes and services. 
.PP
Definition at line 37 of file ksycocaentry.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KSycocaEntry::KSycocaEntry (const \fBQString\fP & path)\fC [inline]\fP"
.PP
Default constructor. 
.PP
Definition at line 51 of file ksycocaentry.h.
.SH "Member Function Documentation"
.PP 
.SS "void KSycocaEntry::read (\fBQDataStream\fP & s, \fBQString\fP & str)\fC [static]\fP"
.PP
Safe demarshalling functions. 
.PP
Definition at line 459 of file ksycoca.cpp.
.PP
References QString::setLength(), and QString::unicode().
.SS "virtual \fBQString\fP KSycocaEntry::name () const\fC [pure virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
the name of this entry 
.RE
.PP

.PP
Implemented in \fBKProtocolInfo\fP, \fBKService\fP, \fBKServiceGroup\fP, and \fBKServiceType\fP.
.SS "\fBQString\fP KSycocaEntry::entryPath () const\fC [inline]\fP"
.PP
\fBReturns:\fP
.RS 4
the path of this entry The path can be absolute or relative. The corresponding factory should know relative to what. 
.RE
.PP

.PP
Definition at line 79 of file ksycocaentry.h.
.SS "virtual bool KSycocaEntry::isValid () const\fC [pure virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
true if valid 
.RE
.PP

.PP
Implemented in \fBKProtocolInfo\fP, \fBKService\fP, \fBKServiceGroup\fP, and \fBKServiceType\fP.
.SS "virtual bool KSycocaEntry::isDeleted () const\fC [inline, virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
true if deleted 
.RE
.PP

.PP
Definition at line 89 of file ksycocaentry.h.
.SH "Friends And Related Function Documentation"
.PP 
.SS "enum \fBKSycocaType\fP\fC [related]\fP"
.PP
A KSycocaType is a code (out of the KSycocaType enum) assigned to each class type derived from KSycocaEntry . 
.PP
To use it, call the macro K_SYCOCATYPE( your_typecode, parent_class ) at the top of your class definition. 
.PP
Definition at line 31 of file ksycocatype.h.

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