File indexing completed on 2024-05-12 04:43:22

0001 /* This file is part of the KDE project
0002  * Copyright (C) 2017 by Adam Pigg (adam@piggz.co.uk)
0003  *
0004  * This library is free software; you can redistribute it and/or
0005  * modify it under the terms of the GNU Lesser General Public
0006  * License as published by the Free Software Foundation; either
0007  * version 2.1 of the License, or (at your option) any later version.
0008  *
0009  * This library is distributed in the hope that it will be useful,
0010  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0011  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
0012  * Lesser General Public License for more details.
0013  *
0014  * You should have received a copy of the GNU Lesser General Public
0015  * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
0016  */
0017 
0018 #ifndef KREPORTSCRIPTSOURCE_H
0019 #define KREPORTSCRIPTSOURCE_H
0020 
0021 #include <QStringList>
0022 #include <QString>
0023 
0024 #include "kreport_export.h"
0025 
0026 /*!
0027  * @brief Abstraction of report script source.
0028  *
0029  * A script source is implemented by the source
0030  * application to provide scripts to the report.
0031  */
0032 class KREPORT_EXPORT KReportScriptSource
0033 {
0034 public:
0035     virtual ~KReportScriptSource();
0036 
0037     //! Allow the implementation to return a list of possible scripts
0038     virtual QStringList scriptList() const = 0;
0039 
0040     //! Allow the implementation to return some script code based on a specific script name
0041     //! as set in the report
0042     virtual QString scriptCode(const QString& script) const = 0;
0043 };
0044 
0045 #endif