• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KDECore

Public Member Functions | Static Public Member Functions | List of all members
KMimeTypeTrader Class Reference

#include <kmimetypetrader.h>

Public Member Functions

 ~KMimeTypeTrader ()
 
KService::Ptr preferredService (const QString &mimeType, const QString &genericServiceType=QString::fromLatin1("Application"))
 
KService::List query (const QString &mimeType, const QString &genericServiceType=QString::fromLatin1("Application"), const QString &constraint=QString()) const
 

Static Public Member Functions

template<class T >
static T * createInstanceFromQuery (const QString &mimeType, const QString &serviceType, QObject *parent=0, const QString &constraint=QString(), const QVariantList &args=QVariantList(), QString *error=0)
 
template<class T >
static T * createPartInstanceFromQuery (const QString &mimeType, QWidget *parentWidget=0, QObject *parent=0, const QString &constraint=QString(), const QVariantList &args=QVariantList(), QString *error=0)
 
static KMimeTypeTrader * self ()
 

Detailed Description

KDE's trader for services associated to a given mimetype.

Example: say that you want to the list of all KParts components that can handle HTML. Our code would look like:

KService::List lst = KMimeTypeTrader::self()->query("text/html",
"KParts/ReadOnlyPart");
KMimeTypeTrader::query
KService::List query(const QString &mimeType, const QString &genericServiceType=QString::fromLatin1("Application"), const QString &constraint=QString()) const
This method returns a list of services which are associated with a given mimetype.
Definition: kmimetypetrader.cpp:142
KMimeTypeTrader::self
static KMimeTypeTrader * self()
This is a static pointer to the KMimeTypeTrader singleton.
Definition: kmimetypetrader.cpp:38
QList< Ptr >

If you want to get the preferred KParts component for text/html you could use preferredService("text/html", "KParts/ReadOnlyPart"), although if this is about loading that component you would use createPartInstanceFromQuery directly.

See also
KServiceTypeTrader, KService

Definition at line 42 of file kmimetypetrader.h.

Constructor & Destructor Documentation

◆ ~KMimeTypeTrader()

KMimeTypeTrader::~KMimeTypeTrader ( )

Standard destructor.

Definition at line 49 of file kmimetypetrader.cpp.

Member Function Documentation

◆ createInstanceFromQuery()

template<class T >
static T * KMimeTypeTrader::createInstanceFromQuery ( const QString &  mimeType,
const QString &  serviceType,
QObject *  parent = 0,
const QString &  constraint = QString(),
const QVariantList &  args = QVariantList(),
QString *  error = 0 
)
inlinestatic

This can be used to create a service instance from a mime type query.

Parameters
mimeTypeA mime type like 'text/plain' or 'text/html'.
serviceTypea basic service type
parentthe parent object for the plugin itself
constraintA constraint to limit the choices returned, QString() to get all services that can handle the given mimetype
argsA list of arguments passed to the service component
errorThe string passed here will contain an error description.
Returns
A pointer to the newly created object or a null pointer if the factory was unable to create an object of the given type.

Definition at line 154 of file kmimetypetrader.h.

◆ createPartInstanceFromQuery()

template<class T >
static T * KMimeTypeTrader::createPartInstanceFromQuery ( const QString &  mimeType,
QWidget *  parentWidget = 0,
QObject *  parent = 0,
const QString &  constraint = QString(),
const QVariantList &  args = QVariantList(),
QString *  error = 0 
)
inlinestatic

This method creates and returns a part object from the trader query for a given mimeType.

Example:

KParts::ReadOnlyPart* part = KMimeTypeTrader::createInstanceFromQuery<KParts::ReadOnlyPart>("text/plain", parentWidget, parentObject);
if (part) {
part->openUrl(url);
part->widget()->show(); // also insert the widget into a layout, or simply use a KVBox as parentWidget
}
Parameters
mimeTypethe mimetype which this part is associated with
parentWidgetthe parent widget, will be set as the parent of the part's widget
parentthe parent object for the part itself
constraintan optional constraint to pass to the trader
argsA list of arguments passed to the service component
errorThe string passed here will contain an error description.
Returns
A pointer to the newly created object or a null pointer if the factory was unable to create an object of the given type.

Definition at line 121 of file kmimetypetrader.h.

◆ preferredService()

KService::Ptr KMimeTypeTrader::preferredService ( const QString &  mimeType,
const QString &  genericServiceType = QString::fromLatin1("Application") 
)

Returns the preferred service for mimeType and genericServiceType.

This is almost like query().first(), except that it also checks if the service is allowed as a preferred service (see KService::allowAsDefault).

Parameters
mimeTypethe mime type (see query())
genericServiceTypethe service type (see query())
Returns
the preferred service, or 0 if no service is available

Definition at line 157 of file kmimetypetrader.cpp.

◆ query()

KService::List KMimeTypeTrader::query ( const QString &  mimeType,
const QString &  genericServiceType = QString::fromLatin1("Application"),
const QString &  constraint = QString() 
) const

This method returns a list of services which are associated with a given mimetype.

Example usage: To get list of applications that can handle a given mimetype, set genericServiceType to "Application" (which is the default). To get list of embeddable components that can handle a given mimetype, set genericServiceType to "KParts/ReadOnlyPart".

The constraint parameter is used to limit the possible choices returned based on the constraints you give it.

The constraint language is rather full. The most common keywords are AND, OR, NOT, IN, and EXIST, all used in an almost spoken-word form. An example is:

(Type == 'Service') and (('Browser/View' in ServiceTypes) and (exist Library))

The keys used in the query (Type, ServiceTypes, Library) are all fields found in the .desktop files.

Parameters
mimeTypeA mime type like 'text/plain' or 'text/html'.
genericServiceTypea basic service type, like 'KParts/ReadOnlyPart' or 'Application'
constraintA constraint to limit the choices returned, QString() to get all services that can handle the given mimetype
Returns
A list of services that satisfy the query, sorted by preference (preferred service first)
See also
http://techbase.kde.org/Development/Tutorials/Services/Traders#The_KTrader_Query_Language

Definition at line 142 of file kmimetypetrader.cpp.

◆ self()

KMimeTypeTrader * KMimeTypeTrader::self ( )
static

This is a static pointer to the KMimeTypeTrader singleton.

You will need to use this to access the KMimeTypeTrader functionality since the constructors are protected.

Returns
Static KMimeTypeTrader instance

Definition at line 38 of file kmimetypetrader.cpp.


The documentation for this class was generated from the following files:
  • kmimetypetrader.h
  • kmimetypetrader.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KDECore

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

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal