← Back to branch summary

~ubuntu-branches/ubuntu/utopic/kde-workspace/utopic-proposed

« back to all changes in this revision

Viewing changes to plasma/generic/dataengines/favicons/faviconprovider.h

  • Committer: Bazaar Package Importer
  • Author(s): Michał Zając
  • Date: 2011-07-09 08:31:15 UTC
  • Revision ID: james.westby@ubuntu.com-20110709083115-ohyxn6z93mily9fc
Tags: upstream-4.6.90
Import upstream version 4.6.90

Show diffs side-by-side

added added

removed removed

Lines of Context:
plasma/generic/dataengines/favicons/faviconprovider.h
 
1
/*
 
2
 *   Copyright (C) 2007 Tobias Koenig <tokoe@kde.org>
 
3
 *   Copyright (C) 2008 Marco Martin <notmart@gmail.com>
 
4
 *
 
5
 *   This program is free software; you can redistribute it and/or modify
 
6
 *   it under the terms of the GNU Library General Public License version 2 as
 
7
 *   published by the Free Software Foundation; either version 2 of the License, or     
 
8
 *   (at your option) any later version.
 
9
 *
 
10
 *   This program is distributed in the hope that it will be useful,
 
11
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 
12
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
13
 *   GNU General Public License for more details
 
14
 *
 
15
 *   You should have received a copy of the GNU Library General Public
 
16
 *   License along with this program; if not, write to the
 
17
 *   Free Software Foundation, Inc.,
 
18
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 
19
 */
 
20
 
 
21
#ifndef FAVICONPROVIDER_H
 
22
#define FAVICONPROVIDER_H
 
23
 
 
24
#include <QtCore/QObject>
 
25
 
 
26
class QImage;
 
27
 
 
28
/**
 
29
 * This class provides a favicon for a given url
 
30
 */
 
31
class FaviconProvider : public QObject
 
32
{
 
33
    Q_OBJECT
 
34
 
 
35
    public:
 
36
        /**
 
37
         * Creates a new favicon provider.
 
38
         *
 
39
         * @param parent The parent object.
 
40
         */
 
41
        FaviconProvider( QObject *parent, const QString &url);
 
42
 
 
43
        /**
 
44
         * Destroys the favicon provider.
 
45
         */
 
46
        ~FaviconProvider();
 
47
 
 
48
        /**
 
49
         * Returns the requested image.
 
50
         *
 
51
         * Note: This method returns only a valid image after the
 
52
         *       finished() signal has been emitted.
 
53
         */
 
54
        QImage image() const;
 
55
 
 
56
        /**
 
57
         * Returns the identifier of the comic request (name + date).
 
58
         */
 
59
        QString identifier() const;
 
60
 
 
61
    Q_SIGNALS:
 
62
        /**
 
63
         * This signal is emitted whenever a request has been finished
 
64
         * successfully.
 
65
         *
 
66
         * @param provider The provider which emitted the signal.
 
67
         */
 
68
        void finished( FaviconProvider *provider );
 
69
 
 
70
        /**
 
71
         * This signal is emitted whenever an error has occurred.
 
72
         *
 
73
         * @param provider The provider which emitted the signal.
 
74
         */
 
75
        void error( FaviconProvider *provider );
 
76
 
 
77
    private:
 
78
      QString m_url;
 
79
 
 
80
      class Private;
 
81
      Private* const d;
 
82
 
 
83
      Q_PRIVATE_SLOT( d, void imageRequestFinished(KJob *job) )
 
84
};
 
85
 
 
86
#endif