mirror of
https://bitbucket.org/smil3y/kdelibs.git
synced 2025-02-24 10:52:49 +00:00
233 lines
9.4 KiB
C
233 lines
9.4 KiB
C
|
/* This file is part of the KDE project
|
||
|
|
Copyright (C) 2001 Simon Hausmann <hausmann@kde.org>
|
||
|
|
Copyright (C) 2002-2006 David Faure <faure@kde.org>
|
||
|
|
|
||
|
|
This library is free software; you can redistribute it and/or
|
||
|
|
modify it under the terms of the GNU Library General Public
|
||
|
|
License as published by the Free Software Foundation; either
|
||
|
|
version 2 of the License, or (at your option) any later version.
|
||
|
|
|
||
|
|
This library is distributed in the hope that it will be useful,
|
||
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
|
|
GNU Library General Public License for more details.
|
||
|
|
|
||
|
|
You should have received a copy of the GNU Library General Public License
|
||
|
|
along with this library; see the file COPYING.LIB. If not, write to the
|
||
|
|
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
||
|
|
Boston, MA 02110-1301, USA.
|
||
|
|
*/
|
||
|
|
#ifndef KPARTS_COMPONENTFACTORY_H
|
||
|
|
#define KPARTS_COMPONENTFACTORY_H
|
||
|
|
|
||
|
|
#include <kparts/factory.h>
|
||
|
|
#include <kparts/part.h>
|
||
|
|
#include <kservicetypetrader.h>
|
||
|
|
#ifndef KDE_NO_DEPRECATED
|
||
|
|
#include <klibloader.h>
|
||
|
|
#endif
|
||
|
|
#include <kmimetypetrader.h>
|
||
|
|
|
||
|
|
#include <QtCore/QFile>
|
||
|
|
|
||
|
|
namespace KParts
|
||
|
|
{
|
||
|
|
namespace ComponentFactory
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* This template function allows to ask the given kparts factory to
|
||
|
|
* create an instance of the given template type.
|
||
|
|
*
|
||
|
|
* Example of usage:
|
||
|
|
* \code
|
||
|
|
* KViewPart *doc = KParts::ComponentFactory::createPartInstanceFromFactory<KViewPart>( factory, parent );
|
||
|
|
* \endcode
|
||
|
|
*
|
||
|
|
* @deprecated use KPluginFactory::create instead
|
||
|
|
*
|
||
|
|
* @param factory The factory to ask for the creation of the component
|
||
|
|
* @param parentWidget the parent widget for the part
|
||
|
|
* @param parent The parent object (see QObject constructor)
|
||
|
|
* @param args A list of string arguments, passed to the factory and possibly
|
||
|
|
* to the component (see KLibFactory)
|
||
|
|
* @return A pointer to the newly created object or a null pointer if the
|
||
|
|
* factory was unable to create an object of the given type.
|
||
|
|
*/
|
||
|
|
#ifndef KDE_NO_DEPRECATED
|
||
|
|
template <class T>
|
||
|
|
KDE_DEPRECATED T *createPartInstanceFromFactory( KParts::Factory *factory,
|
||
|
|
QWidget *parentWidget = 0,
|
||
|
|
QObject *parent = 0,
|
||
|
|
const QStringList &args = QStringList() )
|
||
|
|
{
|
||
|
|
KParts::Part *object = factory->createPart( parentWidget,
|
||
|
|
parent,
|
||
|
|
T::staticMetaObject.className(),
|
||
|
|
args );
|
||
|
|
|
||
|
|
T *result = dynamic_cast<T *>( object );
|
||
|
|
if ( !result )
|
||
|
|
delete object;
|
||
|
|
return result;
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/*
|
||
|
|
* @deprecated use KPluginFactory::create instead
|
||
|
|
*/
|
||
|
|
#ifndef KDE_NO_DEPRECATED
|
||
|
|
template <class T>
|
||
|
|
KDE_DEPRECATED T *createPartInstanceFromLibrary( const char *libraryName,
|
||
|
|
QWidget *parentWidget = 0,
|
||
|
|
QObject *parent = 0,
|
||
|
|
const QStringList &args = QStringList(),
|
||
|
|
int *error = 0 )
|
||
|
|
{
|
||
|
|
KLibrary *library = KLibLoader::self()->library( QFile::decodeName( libraryName ) ); // compatibility hack
|
||
|
|
if ( !library )
|
||
|
|
{
|
||
|
|
if ( error )
|
||
|
|
*error = KLibLoader::ErrNoLibrary;
|
||
|
|
return 0;
|
||
|
|
}
|
||
|
|
KLibFactory *factory = library->factory();
|
||
|
|
if ( !factory )
|
||
|
|
{
|
||
|
|
library->unload();
|
||
|
|
if ( error )
|
||
|
|
*error = KLibLoader::ErrNoFactory;
|
||
|
|
return 0;
|
||
|
|
}
|
||
|
|
KParts::Factory *partFactory = dynamic_cast<KParts::Factory *>( factory );
|
||
|
|
if ( !partFactory )
|
||
|
|
{
|
||
|
|
library->unload();
|
||
|
|
if ( error )
|
||
|
|
*error = KLibLoader::ErrNoFactory;
|
||
|
|
return 0;
|
||
|
|
}
|
||
|
|
T *res = createPartInstanceFromFactory<T>( partFactory, parentWidget,
|
||
|
|
parent, args );
|
||
|
|
if ( !res )
|
||
|
|
{
|
||
|
|
library->unload();
|
||
|
|
if ( error )
|
||
|
|
*error = KLibLoader::ErrNoComponent;
|
||
|
|
}
|
||
|
|
return res;
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @deprecated use KService::createInstance instead
|
||
|
|
*/
|
||
|
|
#ifndef KDE_NO_DEPRECATED
|
||
|
|
template <class T>
|
||
|
|
KDE_DEPRECATED T *createPartInstanceFromService( const KService::Ptr &service,
|
||
|
|
QWidget *parentWidget = 0,
|
||
|
|
QObject *parent = 0,
|
||
|
|
const QStringList &args = QStringList(),
|
||
|
|
int *error = 0 )
|
||
|
|
{
|
||
|
|
QString library = service->library();
|
||
|
|
if ( library.isEmpty() )
|
||
|
|
{
|
||
|
|
if ( error )
|
||
|
|
*error = KLibLoader::ErrServiceProvidesNoLibrary;
|
||
|
|
return 0;
|
||
|
|
}
|
||
|
|
|
||
|
|
return createPartInstanceFromLibrary<T>( QFile::encodeName( library ).constData(), parentWidget,
|
||
|
|
parent, args, error );
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#ifndef KDE_NO_DEPRECATED
|
||
|
|
template <class T, class ServiceIterator>
|
||
|
|
KDE_DEPRECATED T *createPartInstanceFromServices( ServiceIterator begin,
|
||
|
|
ServiceIterator end,
|
||
|
|
QWidget *parentWidget = 0,
|
||
|
|
QObject *parent = 0,
|
||
|
|
const QStringList &args = QStringList(),
|
||
|
|
int *error = 0 )
|
||
|
|
{
|
||
|
|
for (; begin != end; ++begin )
|
||
|
|
{
|
||
|
|
KService::Ptr service = *begin;
|
||
|
|
|
||
|
|
if ( error )
|
||
|
|
*error = 0;
|
||
|
|
|
||
|
|
T *component = createPartInstanceFromService<T>( service, parentWidget,
|
||
|
|
parent, args, error );
|
||
|
|
if ( component )
|
||
|
|
return component;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( error )
|
||
|
|
*error = KLibLoader::ErrNoServiceFound;
|
||
|
|
|
||
|
|
return 0;
|
||
|
|
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This method creates and returns a KParts part from a serviceType (e.g. a mimetype).
|
||
|
|
*
|
||
|
|
* You can use this method to create a generic viewer - that can display any
|
||
|
|
* kind of file, provided that there is a ReadOnlyPart installed for it - in 5 lines:
|
||
|
|
* \code
|
||
|
|
* // Given the following: KUrl url, QWidget* parentWidget and QObject* parentObject.
|
||
|
|
* QString mimetype = KMimeType::findByURL( url )->name();
|
||
|
|
* KParts::ReadOnlyPart* part = KParts::ComponentFactory::createPartInstanceFromQuery<KParts::ReadOnlyPart>( mimetype, QString(), parentWidget, parentObject );
|
||
|
|
* if ( part ) {
|
||
|
|
* part->openUrl( url );
|
||
|
|
* part->widget()->show(); // also insert the widget into a layout, or simply use a KVBox as parentWidget
|
||
|
|
* }
|
||
|
|
* \endcode
|
||
|
|
*
|
||
|
|
* @deprecated use KMimeTypeTrader::createPartInstanceFromQuery instead
|
||
|
|
*
|
||
|
|
* @param mimeType the mimetype which this part is associated with
|
||
|
|
* @param constraint an optional constraint to pass to the trader (see KTrader)
|
||
|
|
* @param parentWidget the parent widget, will be set as the parent of the part's widget
|
||
|
|
* @param parent the parent object for the part itself
|
||
|
|
* @param args A list of string arguments, passed to the factory and possibly
|
||
|
|
* to the component (see KLibFactory)
|
||
|
|
* @param error The int passed here will receive an error code in case of errors.
|
||
|
|
* (See enum KLibLoader::ComponentLoadingError)
|
||
|
|
* @return A pointer to the newly created object or a null pointer if the
|
||
|
|
* factory was unable to create an object of the given type.
|
||
|
|
*/
|
||
|
|
#ifndef KDE_NO_DEPRECATED
|
||
|
|
template <class T>
|
||
|
|
KDE_DEPRECATED T *createPartInstanceFromQuery( const QString &mimeType,
|
||
|
|
const QString &constraint,
|
||
|
|
QWidget *parentWidget = 0,
|
||
|
|
QObject *parent = 0,
|
||
|
|
const QStringList &args = QStringList(),
|
||
|
|
int *error = 0 )
|
||
|
|
{
|
||
|
|
const KService::List offers = KMimeTypeTrader::self()->query( mimeType, QLatin1String("KParts/ReadOnlyPart"), constraint );
|
||
|
|
if ( offers.isEmpty() )
|
||
|
|
{
|
||
|
|
if ( error )
|
||
|
|
*error = KLibLoader::ErrNoServiceFound;
|
||
|
|
return 0;
|
||
|
|
}
|
||
|
|
|
||
|
|
return createPartInstanceFromServices<T>( offers.begin(), offers.end(),
|
||
|
|
parentWidget,
|
||
|
|
parent, args, error );
|
||
|
|
}
|
||
|
|
#endif // KDE_NO_DEPRECATED
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/*
|
||
|
|
* vim: et sw=4
|
||
|
|
*/
|
||
|
|
|
||
|
|
#endif
|