Grantlee  0.4.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_core_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 
105 class GRANTLEE_CORE_EXPORT FilterExpression
106 {
107 public:
112 
116  FilterExpression( const QString &varString, Grantlee::Parser *parser );
117 
121  FilterExpression( const FilterExpression &other );
122 
126  ~FilterExpression();
127 
131  FilterExpression &operator=( const FilterExpression &other );
132 
136  Variable variable() const;
137 
141  QVariant resolve( OutputStream *stream, Context *c ) const;
142 
146  QVariant resolve( Context *c ) const;
147 
152  bool isTrue( Context *c ) const;
153 
158  QVariantList toList( Context *c ) const;
159 
165  bool isValid() const;
166 
167 #ifndef Q_QDOC
168 
172  QStringList filters() const;
173 #endif
174 
175 private:
176  Q_DECLARE_PRIVATE( FilterExpression )
177  FilterExpressionPrivate * const d_ptr;
178 };
179 
180 }
181 
182 #endif
183 
The Context class holds the context to render a template with.
Definition: context.h:109
The Parser class processes a string template into a tree of nodes.
Definition: parser.h:48
A container for static variables defined in Templates.
Definition: variable.h:50
The OutputStream class is used to render templates to a QTextStream.
Definition: outputstream.h:76
A FilterExpression object represents a filter expression in a template.