Cutelyst  1.5.0
viewjson.h
1 /*
2  * Copyright (C) 2015-2016 Daniel Nicoletti <dantti12@gmail.com>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 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  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB. If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19 
20 #ifndef VIEWJSON_H
21 #define VIEWJSON_H
22 
23 #include <Cutelyst/cutelyst_global.h>
24 #include <Cutelyst/view.h>
25 
26 namespace Cutelyst {
27 
28 class ViewJsonPrivate;
33 class CUTELYST_VIEW_JSON_EXPORT ViewJson : public View
34 {
35  Q_OBJECT
36  Q_DECLARE_PRIVATE(ViewJson)
37 public:
38  explicit ViewJson(QObject *parent, const QString &name = QString());
39  virtual ~ViewJson();
40 
41  enum JsonFormat {
42  Indented,
43  Compact
44  };
45  Q_ENUM(JsonFormat)
46 
47 
51  JsonFormat outputFormat() const;
52 
56  void setOutputFormat(JsonFormat format);
57 
58  enum ExposeMode {
59  All,
60  String,
61  StringList,
62  RegularExpression
63  };
64  Q_ENUM(ExposeMode)
65 
66 
70  ExposeMode exposeStashMode() const;
71 
76  void setExposeStashString(const QString &key);
77 
82  void setExposeStashStringList(const QStringList &keys);
83 
88  void setExposeStashRegularExpression(const QRegularExpression &re);
89 
90  QByteArray render(Context *c) const final;
91 
92 protected:
93  ViewJsonPrivate *d_ptr;
94 };
95 
96 }
97 
98 #endif // VIEWJSON_H
The Cutelyst Context.
Definition: context.h:52
The Cutelyst namespace holds all public Cutelyst API.
Definition: Mainpage.dox:7