mirror of
https://bitbucket.org/smil3y/kde-extraapps.git
synced 2025-02-26 20:03:10 +00:00
61 lines
2.2 KiB
C++
61 lines
2.2 KiB
C++
/* This file is part of KDevelop
|
|
Copyright 2009 Aleix Pol <aleixpol@kde.org>
|
|
Copyright 2009 David Nolden <david.nolden.kdevelop@art-master.de>
|
|
Copyright 2010 Benjamin Port <port.benjamin@gmail.com>
|
|
|
|
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 QTHELPPROVIDERABSTRACT_H
|
|
#define QTHELPPROVIDERABSTRACT_H
|
|
|
|
#include <interfaces/idocumentationprovider.h>
|
|
#include <QObject>
|
|
#include <QString>
|
|
#include <QUrl>
|
|
#include <QVariantList>
|
|
#include <QHelpEngine>
|
|
|
|
|
|
class QtHelpProviderAbstract : public QObject, public KDevelop::IDocumentationProvider
|
|
{
|
|
Q_OBJECT
|
|
Q_INTERFACES( KDevelop::IDocumentationProvider )
|
|
public:
|
|
QtHelpProviderAbstract(QObject *parent, const QString &collectionFileName, const QVariantList & args);
|
|
virtual KSharedPtr< KDevelop::IDocumentation > documentationForDeclaration (KDevelop::Declaration*) const;
|
|
|
|
virtual KSharedPtr< KDevelop::IDocumentation > documentationForIndex(const QModelIndex& idx) const;
|
|
virtual QAbstractListModel* indexModel() const;
|
|
|
|
virtual QIcon icon() const = 0;
|
|
virtual QString name() const = 0;
|
|
|
|
virtual KSharedPtr< KDevelop::IDocumentation > homePage() const;
|
|
|
|
/// @return False in case we failed to load any documentation files, else true
|
|
bool isValid() const;
|
|
|
|
QHelpEngine* engine() { return &m_engine; }
|
|
public slots:
|
|
void jumpedTo(const QUrl& newUrl) const;
|
|
signals:
|
|
void addHistory(const KSharedPtr< KDevelop::IDocumentation >& doc) const;
|
|
protected:
|
|
QHelpEngine m_engine;
|
|
};
|
|
|
|
#endif // QTHELPPROVIDERABSTRACT_H
|