Grantlee: templates/lib/filterexpression.h Source File

Grantlee 5.2.0

filterexpression.h
1 /*
2 This file is part of the Grantlee template system.
3
4 Copyright (c) 2009,2010 Stephen Kelly <steveire@gmail.com>
5
6 This library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Lesser General Public
8 License as published by the Free Software Foundation; either version
9 2.1 of the Licence, or (at your option) any later version.
10
11 This library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
15
16 You should have received a copy of the GNU Lesser General Public
17 License along with this library. If not, see <http://www.gnu.org/licenses/>.
18
19 */
20
21 #ifndef GRANTLEE_FILTEREXPRESSION_H
22 #define GRANTLEE_FILTEREXPRESSION_H
23
24 #include "variable.h"
25
26 #include "grantlee_templates_export.h"
27
28 namespace Grantlee
29 {
30 class Filter;
31 class OutputStream;
32 class Parser;
33 struct Token;
34
35 class FilterExpressionPrivate;
36
38
119 class GRANTLEE_TEMPLATES_EXPORT FilterExpression
120 {
121 public:
125 FilterExpression();
126
131 FilterExpression(const QString &varString, Grantlee::Parser *parser);
132
136 FilterExpression(const FilterExpression &other);
137
141 ~FilterExpression();
142
146 FilterExpression &operator=(const FilterExpression &other);
147
151 Variable variable() const;
152
157 QVariant resolve(OutputStream *stream, Context *c) const;
158
162 QVariant resolve(Context *c) const;
163
168 bool isTrue(Context *c) const;
169
176 QVariantList toList(Context *c) const;
177
184 bool isValid() const;
185
186 #ifndef Q_QDOC
187
191 QStringList filters() const;
192 #endif
193
194 private:
195 Q_DECLARE_PRIVATE(FilterExpression)
196 FilterExpressionPrivate *const d_ptr;
197 };
198 }
199
200 #endif
Grantlee::Parser
The Parser class processes a string template into a tree of nodes.
Definition: parser.h:48
Grantlee::Context
The Context class holds the context to render a Template with.
Definition: context.h:117
Grantlee::Variable
A container for static variables defined in Templates.
Definition: variable.h:52
Grantlee::FilterExpression
A FilterExpression object represents a filter expression in a template.
Definition: filterexpression.h:119
Grantlee
The Grantlee namespace holds all public Grantlee API.
Definition: Mainpage.dox:7
Grantlee::OutputStream
The OutputStream class is used to render templates to a QTextStream.
Definition: outputstream.h:80