lib

KoDocumentEntry Class Reference

#include <KoQueryTrader.h>

List of all members.


Detailed Description

Represents an available KOffice component that supports the document interface.

Definition at line 38 of file KoQueryTrader.h.


Public Member Functions

 KoDocumentEntry ()
 KoDocumentEntry (KService::Ptr service)
 ~KoDocumentEntry ()
KService::Ptr service () const
bool isEmpty () const
QString name () const
QStringList mimeTypes () const
bool supportsMimeType (const QString &_mimetype) const
KoDocumentcreateDoc (KoDocument *parent=0, const char *name=0) const

Static Public Member Functions

static QValueList< KoDocumentEntryquery (const QString &_constr=QString::null)
static QValueList< KoDocumentEntryquery (bool _onlyDocEmb, const QString &_constr)
static KoDocumentEntry queryByMimeType (const QString &mimetype)

Constructor & Destructor Documentation

KoDocumentEntry::KoDocumentEntry ( KService::Ptr  service  ) 

Port from KOffice Trader to KTrader/KActivator (kded) by Simon Hausmann (c) 1999 Simon Hausmann <hausmann@kde.org> Port to KService and simplifications by David Faure <faure@kde.org>.

Definition at line 46 of file KoQueryTrader.cpp.


Member Function Documentation

bool KoDocumentEntry::isEmpty (  )  const [inline]

Returns:
TRUE if the service pointer is null

Definition at line 51 of file KoQueryTrader.h.

QString KoDocumentEntry::name (  )  const [inline]

Returns:
name of the associated service

Definition at line 56 of file KoQueryTrader.h.

QStringList KoDocumentEntry::mimeTypes (  )  const [inline]

Mimetypes (and other service types) which this document can handle.

Definition at line 61 of file KoQueryTrader.h.

bool KoDocumentEntry::supportsMimeType ( const QString &  _mimetype  )  const [inline]

Returns:
TRUE if the document can handle the requested mimetype.

Definition at line 66 of file KoQueryTrader.h.

KoDocument * KoDocumentEntry::createDoc ( KoDocument parent = 0,
const char *  name = 0 
) const

Uses the factory of the component to create a document.

If that is not possible, 0 is returned.

Definition at line 51 of file KoQueryTrader.cpp.

QValueList< KoDocumentEntry > KoDocumentEntry::query ( const QString &  _constr = QString::null  )  [static]

This function will query ksycoca to find all available components.

The result will only contain parts, which are embeddable into a document

Parameters:
_constr is a constraint expression as used by KTrader. You can use it to set additional restrictions on the available components.

Definition at line 108 of file KoQueryTrader.cpp.

QValueList< KoDocumentEntry > KoDocumentEntry::query ( bool  _onlyDocEmb,
const QString &  _constr 
) [static]

This function will query the system to find all available filters.

Parameters:
_onlyDocEmb specifies if only KOffice Parts should be listed which are embeddable into other koDocuments, or all (if false) (eg.: it makes no sense to embed Kexi into KWord, but it makes sense to embed it into KoShell)
_constr is a constraint expression as used by KDEDs trader interface. You can use it to set additional restrictions on the available components.

Definition at line 113 of file KoQueryTrader.cpp.

KoDocumentEntry KoDocumentEntry::queryByMimeType ( const QString &  mimetype  )  [static]

This is a convenience function.

Returns:
a document entry for the KOffice component that supports the requested mimetype and fits the user best.

Definition at line 77 of file KoQueryTrader.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys