Cutelyst  1.8.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:
41  explicit ViewJson(QObject *parent, const QString &name = QString());
42  virtual ~ViewJson();
43 
45  enum JsonFormat {
47  Compact
48  };
49  Q_ENUM(JsonFormat)
50 
51 
55  JsonFormat outputFormat() const;
56 
60  void setOutputFormat(JsonFormat format);
61 
63  enum ExposeMode {
64  All,
65  String,
66  StringList,
67  RegularExpression
68  };
69  Q_ENUM(ExposeMode)
70 
71 
75  ExposeMode exposeStashMode() const;
76 
81  void setExposeStashString(const QString &key);
82 
87  void setExposeStashStringList(const QStringList &keys);
88 
93  void setExposeStashRegularExpression(const QRegularExpression &re);
94 
95  QByteArray render(Context *c) const final;
96 
97 protected:
98  ViewJsonPrivate *d_ptr;
99 };
100 
101 }
102 
103 #endif // VIEWJSON_H
The Cutelyst Context.
Definition: context.h:52
The Cutelyst namespace holds all public Cutelyst API.
Definition: Mainpage.dox:7
Cutelyst View abstract view component
Definition: view.h:35