mirror of
https://bitbucket.org/smil3y/kde-workspace.git
synced 2025-02-24 19:02:51 +00:00
128 lines
4.7 KiB
C++
128 lines
4.7 KiB
C++
/* This file is part of the KDE Project
|
|
Copyright (c) 2001 Malte Starostik <malte@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 version 2 as published by the Free Software Foundation.
|
|
|
|
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 _FAVICONS_H_
|
|
#define _FAVICONS_H_
|
|
|
|
#include <kdedmodule.h>
|
|
#include <kurl.h>
|
|
|
|
class KJob;
|
|
namespace KIO { class Job; }
|
|
|
|
/**
|
|
* KDED Module to handle shortcut icons ("favicons")
|
|
* FavIconsModule implements a KDED Module that handles the association of
|
|
* URLs and hosts with shortcut icons and the icons' downloads in a central
|
|
* place.
|
|
*
|
|
* After a successful download, the D-Bus signal iconChanged() is emitted.
|
|
* It has the signature void iconChanged(bool, QString, QString);
|
|
* The first parameter is true if the icon is a "host" icon, that is it is
|
|
* the default icon for all URLs on the given host. In this case, the
|
|
* second parameter is a host name, otherwise the second parameter is the
|
|
* URL which is associated with the icon. The third parameter is the
|
|
* @ref KIconLoader friendly name of the downloaded icon, the same as
|
|
* @ref iconForUrl will from now on return for any matching URL.
|
|
*
|
|
* @short KDED Module for favicons
|
|
* @author Malte Starostik <malte@kde.org>
|
|
*/
|
|
class FavIconsModule : public KDEDModule
|
|
{
|
|
Q_OBJECT
|
|
Q_CLASSINFO("D-Bus Interface", "org.kde.FavIcon")
|
|
|
|
public:
|
|
FavIconsModule(QObject* parent, const QList<QVariant>&);
|
|
virtual ~FavIconsModule();
|
|
|
|
public Q_SLOTS: // dbus methods, called by the adaptor
|
|
/**
|
|
* Looks up an icon name for a given URL. This function does not
|
|
* initiate any download. If no icon for the URL or its host has
|
|
* been downloaded yet, QString() is returned.
|
|
*
|
|
* @param url the URL for which the icon is queried
|
|
* @return the icon name suitable to pass to @ref KIconLoader or
|
|
* QString() if no icon for this URL was found.
|
|
*/
|
|
QString iconForUrl(const KUrl &url);
|
|
|
|
/**
|
|
* Associates an icon with the given URL. If the icon was not
|
|
* downloaded before or the downloaded was too long ago, a
|
|
* download attempt will be started and the iconChanged() D-Bus
|
|
* signal is emitted after the download finished successfully.
|
|
*
|
|
* @param url the URL which will be associated with the icon
|
|
* @param iconURL the URL of the icon to be downloaded
|
|
*/
|
|
void setIconForUrl(const KUrl &url, const KUrl &iconURL);
|
|
/**
|
|
* Downloads the icon for a given host if it was not downloaded before
|
|
* or the download was too long ago. If the download finishes
|
|
* successfully, the iconChanged() D-Bus signal is emitted.
|
|
*
|
|
* @param url any URL on the host for which the icon is to be downloaded
|
|
*/
|
|
void downloadHostIcon(const KUrl &url);
|
|
|
|
/**
|
|
* Downloads the icon for a given host, even if we tried very recently.
|
|
* Not recommended in the general case; only useful for explicit "update favicon"
|
|
* actions from the user.
|
|
*
|
|
* If the download finishes successfully, the iconChanged() D-Bus signal is emitted.
|
|
*
|
|
* @param url any URL on the host for which the icon is to be downloaded
|
|
*/
|
|
void forceDownloadHostIcon(const KUrl &url);
|
|
|
|
signals: // D-Bus signals
|
|
/**
|
|
* Emitted once a new icon is available, for a host or url
|
|
*/
|
|
void iconChanged(bool isHost, QString hostOrURL, QString iconName);
|
|
/**
|
|
* Progress info while downloading an icon
|
|
*/
|
|
void infoMessage(QString iconURL, QString msg);
|
|
/**
|
|
* Emitted if an error occurred while downloading the icon for the given host or url.
|
|
* You can usually ignore this (e.g. web browsers don't need to do anything if
|
|
* no favicon was found), but this signal can be useful in some cases, e.g.
|
|
* to let keditbookmarks know that it should move on to the next bookmark.
|
|
*/
|
|
void error(bool isHost, QString hostOrURL, QString errorString);
|
|
|
|
private:
|
|
void startDownload(const QString &, bool, const KUrl &);
|
|
|
|
private Q_SLOTS:
|
|
void slotData(KIO::Job *, const QByteArray &);
|
|
void slotResult(KJob *);
|
|
void slotInfoMessage(KJob *, const QString &);
|
|
|
|
private:
|
|
struct FavIconsModulePrivate *d;
|
|
};
|
|
|
|
#endif
|
|
|
|
// vim: ts=4 sw=4 et
|