KReport

KReportScriptSource.h
1 /* This file is part of the KDE project
2  * Copyright (C) 2017 by Adam Pigg ([email protected])
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
16  */
17 
18 #ifndef KREPORTSCRIPTSOURCE_H
19 #define KREPORTSCRIPTSOURCE_H
20 
21 #include <QStringList>
22 #include <QString>
23 
24 #include "kreport_export.h"
25 
26 /*!
27  * @brief Abstraction of report script source.
28  *
29  * A script source is implemented by the source
30  * application to provide scripts to the report.
31  */
32 class KREPORT_EXPORT KReportScriptSource
33 {
34 public:
35  virtual ~KReportScriptSource();
36 
37  //! Allow the implementation to return a list of possible scripts
38  virtual QStringList scriptList() const = 0;
39 
40  //! Allow the implementation to return some script code based on a specific script name
41  //! as set in the report
42  virtual QString scriptCode(const QString& script) const = 0;
43 };
44 
45 #endif
Abstraction of report script source.
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Mon Aug 15 2022 04:16:28 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.