mirror of
https://bitbucket.org/smil3y/kde-extraapps.git
synced 2025-02-24 19:02:53 +00:00
105 lines
2.9 KiB
C++
105 lines
2.9 KiB
C++
/*
|
|
* Copyright (C) 2007 Tobias Koenig <tokoe@kde.org>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program 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 General Public License for more details
|
|
*
|
|
* You should have received a copy of the GNU Library General Public
|
|
* License along with this program; if not, write to the
|
|
* Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef POTDPROVIDER_H
|
|
#define POTDPROVIDER_H
|
|
|
|
#include <QtCore/QObject>
|
|
#include <QtCore/QDate>
|
|
|
|
#include <kpluginfactory.h>
|
|
|
|
#include "plasma_potd_export.h"
|
|
|
|
class QImage;
|
|
|
|
#define POTDPROVIDER_EXPORT_PLUGIN( classname, componentName, catalogName ) \
|
|
K_PLUGIN_FACTORY( classname ## Factory, registerPlugin< classname >(); ) \
|
|
K_EXPORT_PLUGIN( classname ## Factory( componentName, catalogName ) )
|
|
|
|
/**
|
|
* This class is an interface for PoTD providers.
|
|
*/
|
|
class PLASMA_POTD_EXPORT PotdProvider : public QObject
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
/**
|
|
* Creates a new PoTD provider.
|
|
*
|
|
* @param parent The parent object.
|
|
*/
|
|
PotdProvider( QObject *parent, const QVariantList &args = QVariantList() );
|
|
|
|
/**
|
|
* Destroys the PoTD provider.
|
|
*/
|
|
virtual ~PotdProvider();
|
|
|
|
/**
|
|
* Returns the requested image.
|
|
*
|
|
* Note: This method returns only a valid image after the
|
|
* finished() signal has been emitted.
|
|
*/
|
|
virtual QImage image() const = 0;
|
|
|
|
/**
|
|
* Returns the identifier of the PoTD request (name + date).
|
|
*/
|
|
virtual QString identifier() const;
|
|
|
|
/**
|
|
* @return the name of this provider (equiv to X-KDE-PlasmaPoTDProvider-Identifier)
|
|
*/
|
|
QString name() const;
|
|
|
|
/**
|
|
* @reutrn the date to load for this item, if any
|
|
*/
|
|
QDate date() const;
|
|
|
|
/**
|
|
* @return if the date is fixed, or if it should always be "today"
|
|
*/
|
|
bool isFixedDate() const;
|
|
|
|
Q_SIGNALS:
|
|
/**
|
|
* This signal is emitted whenever a request has been finished
|
|
* successfully.
|
|
*
|
|
* @param provider The provider which emitted the signal.
|
|
*/
|
|
void finished( PotdProvider *provider );
|
|
|
|
/**
|
|
* This signal is emitted whenever an error has occurred.
|
|
*
|
|
* @param provider The provider which emitted the signal.
|
|
*/
|
|
void error( PotdProvider *provider );
|
|
|
|
private:
|
|
class Private;
|
|
Private * const d;
|
|
};
|
|
|
|
#endif
|