File indexing completed on 2024-04-21 11:14:07

0001 /*
0002     SPDX-License-Identifier: GPL-2.0-or-later
0003     SPDX-FileCopyrightText: 2009 Alexander Rieder <alexanderrieder@gmail.com>
0004 */
0005 
0006 #ifndef _HELPRESULT_H
0007 #define _HELPRESULT_H
0008 
0009 #include "textresult.h"
0010 
0011 namespace Cantor
0012 {
0013 
0014 /** this is basically a TextResult, just with a different Type
0015     so that the application can show it in another way than the
0016     normal results
0017 **/
0018 class HelpResultPrivate;
0019 class CANTOR_EXPORT HelpResult: public Result
0020 {
0021   public:
0022     enum {Type=3};
0023     explicit HelpResult( const QString& text, bool isHtml=false);
0024     ~HelpResult() override;
0025 
0026     QVariant data() override;
0027     QString toHtml() override;
0028 
0029     int type() override;
0030     QString mimeType() override;
0031 
0032     QDomElement toXml(QDomDocument& doc) override;
0033     QJsonValue toJupyterJson() override;
0034     void save(const QString& filename) override;
0035 
0036   private:
0037     HelpResultPrivate* d;
0038 };
0039 
0040 }
0041 
0042 #endif /* _HELPRESULT_H */